一种好的注释风格

有时候接过项目组里的童鞋的代码模块，一看，晕倒，变量命名得乱七八糟的，类、方法的注释也是五花八门。即使开始做项目之前定好了编码规范，大家还都是按自个的习惯来，没办法，都是学生团队。

我喜欢的编码规范：

类命名：MyClass （每个单词大写开头）

方法命名：myCat（驼峰命名，你懂的）

类变量命名：g_var（g_开头）

实例变量命名：var（直接变量名）

内部变量命名：_var（下划线开头）

接下来是注释，看一段代码：

.h文件

// // MyGirl // 在这里注明这个类主要功能 // // // #import <Fucation/Fucation.h> @interface MyGirl: NSObject { NSString *name; } -(void)kissMe:(Me*)aMe; @end

 

.m文件

#import "MyGirl.h" #import "DEBUG.h" @implementation MyGirl /* *----------------------------------------------------------------------------- * * -[myGirl kissMe:] -- * * 描述这个方法都干了什么，有什么功能 * to do stuff * * Results: * 返回什么 * * Side effects: * 副作用，将来带什么影响？ * *----------------------------------------------------------------------------- */ -(void)kissMe:(Me*)aMe{ NSString *_myName; //我的名字 _myName = aMe.name; #ifdef DEBUG NSLog(@"kiss %@",_myName); #endif } @end