c語言中可以對程式進行註釋,註釋部分如果佔多行,必須以__開始
- 2022-09-13
以註釋內容開始。
關於程式中註釋書寫格式
1程式檔案註釋:
放在程式名稱空間引用(using System。IO;)的上面,主要寫公司的版權、檔案建立的時間、檔案的主要內容、檔案的名字、檔案的建立標識(建立人姓名)、檔案修改的時間、檔案修改時的修改標識(修改人姓名)、檔案修改的修改原因等(詳情見文件後備注示例);
2類的作用註釋:
放在類(類、介面、列舉、結構體)的宣告上方,主要描述類的作用。
如果類的結構比較複雜,也應該新增類的使用示例和類的流程(其它特點)
3、類的私有全域性重要變數註釋:
放在類的全域性變數宣告上方,主要需要註釋透過命名不能正確理解的全域性私有或公有(包含受保護等)變數。如果是object(特殊陣列等)型變數,內部使用時結構比較複雜或有規定,需要簡要的說明一下內部結構。
4、類的屬性的註釋:
放在類的屬性宣告上方,簡要說明屬性的型別和主要作用。
5、類的公有方法的註釋:
主要說明方法的作用,方法各引數的意義和要求,方法的返回值及各種可能的返回值的特殊意義,方法可能會產生的異常,如果需要,則可以寫出方法的使用示例;
6、類的私有方法或重要演算法的註釋:
除了需要說明公有方法所要求的之外,如果演算法、數學運算比較複雜,需要寫出演算法或數學方法的理論過程或推導過程;如果演算法比較長,要儘可能的細分成邏輯塊,並填寫適當的註釋;對於方法中的重要變數也要新增適當的註釋,特別是對方法的結果或方法某一段的結果的方法內部不易理解的變數要新增合適的註釋;對於特別複雜(重要)的方法,要新增適當的流程圖或文件,給以充分的文字、圖解等說明;
7、檔案、類或類的方法修改後的註釋的變更:
對於對檔案或類(包括介面、列舉、結構體)或類的方法修改後,要新增修改後的相註釋,要寫清修改的時間、修改標識(修改人姓名)、修改的原因等一切必要的資訊和一切必要變更的資訊(類、方法的流程);
/*註釋內容*/ 多行註釋
//註釋內容 單行註釋
C語言中註釋符號有兩種
一種是行註釋符“//”
另一種是塊註釋符“/*”和“*/”
如果是多行,可以用塊註釋符,開始用“ /* ”標識註釋的開始,“ */ ”標識註釋塊的結束
上一篇:車前擋風玻璃貼膜了,能用防霧劑嗎
下一篇:最近被同學發現右眼有點斜視