注釋是原始碼程式中非常重要的一部分,一般情況下,源程式有效注釋量必須在20%以上。
注釋的原則是有助於對程式的閱讀理解,所以注釋語言必須準確、易懂、簡潔,注釋不宜太多也不能太少,注釋的內容要清楚、明了、含義準確,防止注釋二義性,該加的地方一定要加,但不必要的地方一定不要加。
注釋風格很多,這裡只是對於我的**進行規範。
/*
* filename: ***
* description: balabalabalabalabalabalabalabalabala
balabalabalabalabalabalabalabalabalabalabalabala
* change logs:
|date |author |notes |version
|2010-03-22 |*** |*** |1.0.0
*/
/*
* function:
* description:
* calls:
* input:
* input:
* output:
* return:
* others:
*/
/* @define *** */
#define ***_error_ok 0 /* no error */
#define ***_error_invalid_token 1 /* invalid token */
#define ***_error_expect_type 2 /* expect a type */
/* @struct *** */
struct ***_syscall_item
;
全域性變數要有較詳細的注釋,包括對其功能、取值範圍、哪些函式或過程訪問它以及訪問時注意事項等的說明。
/* @variable temp */
/* scope: 儲存溫度值 */
/* range: -128 - 127 */
/* notice: ***xx */
/* others: ***xx */
extern char temp = 0;
C語言 注釋轉換(C風格 C 風格)
其中有一些檔案操作函式,不懂的可以看這篇部落格 首先,我們要知道乙個檔案中至少有五種狀態,我們用狀態圖表示 解讀 我們從 不是注釋 的狀態開始,請看下圖 有以下幾種情況需要注意 轉變成 轉變成 判斷是否為換行,如果換行需要輸入 轉變成 如果準備出注釋的時候,遇到 先保留看下乙個字元是不是 如果是 在...
小專案 簡單注釋轉換(C風格轉到C 風格)
c的注釋是以字元 開始,以字元 結束,注釋被包含的內容。c 的注釋是以字元 開始,碰到換行符 n 時結束,注釋一行。所以,從c注釋轉到c 就是在碰到 時將換成 碰到 時 將其刪除。當然,這裡會有許多種需要細心情況,我們下面再談。完成這個專案,我們需要把 劃分4個狀態,null 無狀態 c狀態,cpp...
將c風格的注釋轉換成cpp風格
首先要將文字分成四個狀態 1.普通狀態 nullstatus 2.c狀態 cstatus 3.cpp狀態 cpstatus 4.eof狀態 eofstatus 四個狀態之間的關係如下 程式 如下 main.c include convert.h int main convert.h ifndef c...