c 注釋規範

2021-07-05 06:22:32 字數 522 閱讀 6978

模組開始必須以以下格式編寫模組注釋

//////模組編號:《模組編號,可以引用系統設計中的模組編號》

///作用:《對此類的描述,可以引用系統設計中的描述》

///編寫日期《模組建立日期,格式:yyyy-mm-dd>

///

如果模組有修改,則每次修改必須新增以下注釋

//////log編號:///修改描述:《對此修改的描述》

//修改日期:《模組修改日期:格式:yyyy-mm-dd>

///

類屬性注視規範

//////屬性說明

///

方法注釋規範

//////說明:《對該方法的說明》

///

///《引數說明》

//////《對此方法返回值的說明,該說明必須明確說明返回值代表什麼含義。>

///

**間注視規範

//《單行注釋》

/*多行注釋1

多行注釋2

多行注釋3*/

#c#雜項

C 注釋規範

5.注釋 5.1.注釋的基本約定 注釋應該增加 的清晰度 保持注釋的簡潔,不是任何 都需要注釋的,過多的注釋反而會影響 的可讀性。注釋不要包括其他的特殊字元。建議先寫注釋,後寫 注釋和 一起完成 如果語句塊 比如迴圈和條件分枝的 塊 太長,巢狀太多,則在其結束 要加上注釋,標誌對應的開始語句。如果分...

c 注釋規範

列出 版權 作者 編寫日期和描述。示例 author date 2010 08 25 description 描述主要實現的功能 每行不要超過80個字元的寬度。列出 函式的目的 功能 輸入引數 輸出引數 返回值 呼叫關係 函式 表 等。示例 下面這段函式的注釋比較標準,當然,並不侷限於此格式,但上述...

C 注釋規範

注釋這玩意我覺得多了沒啥不好,越詳細越好,為了防止注釋多了比較亂,就規則一下規則 以下也是綜合了網上好幾個地方的。另外我加注釋一般是在c 的標頭檔案中。列出 版權 作者 編寫日期和描述。示例 author date 2010 08 25 description 描述主要實現的功能 每行不要超過80個...