劇多
首頁
資訊
體育
娛樂
汽車
投資
財經
軍事
科技
數碼
科學
遊戲
歷史
健康
政治
影視
旅遊
育兒
美食
時尚
房產
農業
社會
文化
教育
技術
美文
情感
故事
家居
職場
自然
闢謠
心理
攝影
漫畫
生活
其它
Club
Tips
熱門話題
搜尋
註冊
登入
首頁
>
Club
>
2021-02-12 18:56
c語言中可以對程式進行註釋?
4
回覆列表
1 # 被囚禁的王者
以註釋內容開始。
關於程式中註釋書寫格式1程式檔案註釋:放在程式名稱空間引用(using System.IO;)的上面,主要寫公司的版權、檔案建立的時間、檔案的主要內容、檔案的名字、檔案的建立標識(建立人姓名)、檔案修改的時間、檔案修改時的修改標識(修改人姓名)、檔案修改的修改原因等(詳情見文件後備注示例);2類的作用註釋:放在類(類、介面、列舉、結構體)的宣告上方,主要描述類的作用。如果類的結構比較複雜,也應該新增類的使用示例和類的流程(其它特點)3、類的私有全域性重要變數註釋:放在類的全域性變數宣告上方,主要需要註釋透過命名不能正確理解的全域性私有或公有(包含受保護等)變數。如果是object(特殊陣列等)型變數,內部使用時結構比較複雜或有規定,需要簡要的說明一下內部結構。4、類的屬性的註釋:放在類的屬性宣告上方,簡要說明屬性的型別和主要作用。5、類的公有方法的註釋:主要說明方法的作用,方法各引數的意義和要求,方法的返回值及各種可能的返回值的特殊意義,方法可能會產生的異常,如果需要,則可以寫出方法的使用示例;6、類的私有方法或重要演算法的註釋:除了需要說明公有方法所要求的之外,如果演算法、數學運算比較複雜,需要寫出演算法或數學方法的理論過程或推導過程;如果演算法比較長,要儘可能的細分成邏輯塊,並填寫適當的註釋;對於方法中的重要變數也要新增適當的註釋,特別是對方法的結果或方法某一段的結果的方法內部不易理解的變數要新增合適的註釋;對於特別複雜(重要)的方法,要新增適當的流程圖或文件,給以充分的文字、圖解等說明;7、檔案、類或類的方法修改後的註釋的變更:對於對檔案或類(包括介面、列舉、結構體)或類的方法修改後,要新增修改後的相註釋,要寫清修改的時間、修改標識(修改人姓名)、修改的原因等一切必要的資訊和一切必要變更的資訊(類、方法的流程);
發表回復
相關內容
C語言可以寫多少個程式,為什麼?
求FFT的c語言程式?
這個c語言程式怎麼寫?大小寫字母轉換,原程式如下?
如何在c語言中跳出程式的執行?
C語言問題,編寫一程式將兩個字串連起來?
c語言編寫的程式被稱為什麼?
∧
中秋節和大豐收的關聯?
∨
B2B模式、B2C模式、C2C模式分別是什麼含義?
熱門排行
星途瑤光兩驅優享版後視鏡電加熱怎麼用?
華為mate60pro超級微距能看到蟎蟲嗎?
原神如何快速拿到凱亞皮膚?
carxstreet亞洲為什麼進不去?
用珍珠粉和牛奶做面膜?
拼好飯沒人拼會怎麼樣?
中醫臨床全科醫學學什麼?
溫控面板不亮?
剪輯中如何讓多張照片切換絲滑?
繁殖小太陽鸚鵡需要什麼手續?
以註釋內容開始。
關於程式中註釋書寫格式1程式檔案註釋:放在程式名稱空間引用(using System.IO;)的上面,主要寫公司的版權、檔案建立的時間、檔案的主要內容、檔案的名字、檔案的建立標識(建立人姓名)、檔案修改的時間、檔案修改時的修改標識(修改人姓名)、檔案修改的修改原因等(詳情見文件後備注示例);2類的作用註釋:放在類(類、介面、列舉、結構體)的宣告上方,主要描述類的作用。如果類的結構比較複雜,也應該新增類的使用示例和類的流程(其它特點)3、類的私有全域性重要變數註釋:放在類的全域性變數宣告上方,主要需要註釋透過命名不能正確理解的全域性私有或公有(包含受保護等)變數。如果是object(特殊陣列等)型變數,內部使用時結構比較複雜或有規定,需要簡要的說明一下內部結構。4、類的屬性的註釋:放在類的屬性宣告上方,簡要說明屬性的型別和主要作用。5、類的公有方法的註釋:主要說明方法的作用,方法各引數的意義和要求,方法的返回值及各種可能的返回值的特殊意義,方法可能會產生的異常,如果需要,則可以寫出方法的使用示例;6、類的私有方法或重要演算法的註釋:除了需要說明公有方法所要求的之外,如果演算法、數學運算比較複雜,需要寫出演算法或數學方法的理論過程或推導過程;如果演算法比較長,要儘可能的細分成邏輯塊,並填寫適當的註釋;對於方法中的重要變數也要新增適當的註釋,特別是對方法的結果或方法某一段的結果的方法內部不易理解的變數要新增合適的註釋;對於特別複雜(重要)的方法,要新增適當的流程圖或文件,給以充分的文字、圖解等說明;7、檔案、類或類的方法修改後的註釋的變更:對於對檔案或類(包括介面、列舉、結構體)或類的方法修改後,要新增修改後的相註釋,要寫清修改的時間、修改標識(修改人姓名)、修改的原因等一切必要的資訊和一切必要變更的資訊(類、方法的流程);