一種好的注釋風格

有時候接過項目組裡的童鞋的代碼模組，一看，暈倒，變數命名得亂七八糟的，類、方法的注釋也是五花八門。即使開始做項目之前定好了編碼規範，大家還都是按自個的習慣來，沒辦法，都是學生團隊。

我喜歡的編碼規範：

類命名：MyClass （每個單詞大寫開頭）

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

類變數命名：g_var（g_開頭）

執行個體變數命名：var（直接變數名）

內部變數命名：_var（底線開頭）

接下來是注釋，看一段代碼：

.h檔案

//////////////////////////////<br />// MyGirl<br />// 在這裡註明這個類主要功能<br />//<br />//<br />//////////////////////////////<br />#import <Fucation/Fucation.h></p><p>@interface MyGirl: NSObject {</p><p> NSString *name;</p><p>}<br />-(void)kissMe:(Me*)aMe;<br />@end

 

.m檔案

#import "MyGirl.h"<br />#import "DEBUG.h"<br />@implementation MyGirl<br />/*<br />*-----------------------------------------------------------------------------<br />*<br />* -[myGirl kissMe:] --<br />*<br />* 描述這個方法都幹了什麼，有什麼功能<br />* to do stuff<br />*<br />* Results:<br />* 返回什麼<br />*<br />* Side effects:<br />* 副作用，將來帶什麼影響？<br />*<br />*----------------------------------------------------------------------------- */ -(void)kissMe:(Me*)aMe{ </p><p> NSString *_myName; //我的名字<br /> _myName = aMe.name;<br /> #ifdef DEBUG<br /> NSLog(@"kiss %@",_myName);<br /> #endif<br /> }<br />@end