3.2 文檔型注釋
該類注釋采用.Net已定義好的XML標簽來標記,在聲明接口、類、方法、屬性、字段都應該使用該類注釋,以便代碼完成後直接生成代碼文檔,讓別人更好的了解代碼的實現和接口。如
///<summary>MyMethod is a method in the MyClass class.
///<para>Here's how you could make a second paragraph in a description.
///<see cref="System.Console.WriteLine"/>
///for information about output statements.
///</para>
///<seealso cref="MyClass.Main"/>
///</summary>
public static void MyMethod(int Int1)
{
}
3.3 類c注釋
該類注釋用於
1) 不再使用的代碼。
2) 臨時測試屏蔽某些代碼。
用法
/*
[修改標識]
[修改原因]
. . . (the source code )
*/
3.4 單行注釋
該類注釋用於
1) 方法內的代碼注釋。如變量的聲明、代碼或代碼段的解釋。注釋示例:
//
// 注釋語句
//
private int number;
或
// 注釋語句
private int number;
2) 方法內變量的聲明或花括號後的注釋, 注釋示例:
if ( 1 == 1) // always true
{
statement;
} // always true
4 申明
4.1 每行聲明數
一行只建議作一個聲明,並按字母順序排列。如:
int level; //推薦
int size; //推薦
int x, y; //不推薦
4.2 初始化
建議在變量聲明時就對其做初始化。