objc&swift注释相关

objc：

#pragma mark - 一个测试方法
/*!
 @brief 对方法的描述
 @warning 方法警告相关
 @param varA: 该参数的解释
 @param varB: 该参数的解释
 @return 返回值相关介绍
 */
- (NSString *)testMethodWithParamA:(id)varA paramB:(id)varB;

对应效果图

objc.png

swift：

//MARK: - 一个测试方法
/**
 对方法的描述
- warning 方法警告相关
- parameter varA: 该参数的解释
- parameter varB: 该参数的解释
- returns: 返回值相关介绍
 */
func testMethod(varA: AnyObject, varB: AnyObject) -> String

对应效果图

swift.png

不想手打也有现成的插件，比如VVDocument，都是为了更好的码代码