程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> C語言 >> 關於C語言 >> C#編程規范---上(5)

C#編程規范---上(5)

編輯:關於C語言

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 初始化

建議在變量聲明時就對其做初始化。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved