分享 關於c 注釋的規範

2022-02-16 12:12:57 字數 957 閱讀 2751

c# 提供一種機制

,使程式設計師可以使用含有 xml 文字的特殊注釋語法為他們的**編寫文件。在源**檔案中,具有某種格式的注釋可用於指導某個工具根據這些注釋和它們後面的源**元素生成 xml。使用這類語法的注釋稱為文件注釋

(documentation comment)

。這些注釋後面必須緊跟使用者定義型別

(如類、委託或介面

)或者成員

(如欄位、事件、屬性或方法

)。xml 生成工具稱作文件生成器

(documentation generator)。(

此生成器可以但不一定必須是 c# 編譯器本身。)由文件生成器產生的輸出稱為文件檔案

(documentation file)

。文件檔案可作為文件檢視器

(documentation viewer)

的輸入;

文件檢視器是用於生成型別資訊及其關聯文件的某種視覺化顯示的工具。

下面是我找到的並認為是比較好的學習資料,內容不多,相信大家在半個小時內就能明白並運用到project的**中。

簡略版:        

比較全面的版本:

這些資料講的是如何注釋規範並產生乙個注釋的xml文件,那麼如何用vs(2010)生成乙個xml的注釋文件呢?這個也很方便,只需要在工程檔案的屬性中,build選項中將xml documentation file選項選上即可。

但是對於我們來說比較關心如何將xml轉換為乙個可視話的東西,比如html,chm,pdf,所以下面在提供乙個鏈結該鏈結後面提到了如何將注釋xml轉化為html的方法。

該鏈結是將xml檔案轉化到chm的方法。

這些不難,只要耐心的看一會就能學會。希望對大家有幫助!

microteam  liuhang

我們來自  

C 注釋規範

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

c 注釋規範

模組開始必須以以下格式編寫模組注釋 模組編號 模組編號,可以引用系統設計中的模組編號 作用 對此類的描述,可以引用系統設計中的描述 編寫日期 模組建立日期,格式 yyyy mm dd 如果模組有修改,則每次修改必須新增以下注釋 log編號 修改描述 對此修改的描述 修改日期 模組修改日期 格式 yy...

c 注釋規範

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