當前位置:法律諮詢服務網 - 法律援助 - 畢業後C語言註釋必須註意的幾點

畢業後C語言註釋必須註意的幾點

c語言筆記註意的是必須知道的東西。

註釋樣式

1.概觀

//或者/* */壹般都用,只要統壹就行。

解釋

//或者/* */都可以,但是//更常用,所以在如何標註和註釋樣式上要保證統壹性。

文件註釋

1.概觀

添加版權、作者、時間等描述。在每個文件的開頭。文件註釋描述了文件的內容。如果壹個文件只聲明、實現或測試壹個對象,並且這個對象在聲明時已經被詳細註釋,那麽就沒有必要添加文件註釋,其他所有文件都需要文件註釋。

解釋

法律聲明和作者信息:

每個文件都應該包含許可參考,並為項目選擇合適的許可版本(例如,Apache 2.0、BSD、LGPL、GPL)。

如果您對原作者檔案進行了重大修改,請考慮刪除原作者信息。

函數註釋

1.概觀

函數聲明中的註釋描述了函數:定義中的註釋描述了函數的實現。

解釋

函數聲明:

基本上每個函數聲明前都要加上註釋,描述函數的作用和用途,只有在函數簡單明顯的情況下(比如簡單的取值和置值函數),才能省略這些註釋。函數定義:

如果函數以巧妙的方式實現,應該在函數定義中添加註釋。比如妳使用的編程技巧,實現的壹般步驟,或者解釋壹下這樣實現的原因。比如,妳可以解釋為什麽函數的前半部分被鎖定,後半部分不需要。

變量註釋

1.概觀

在某些情況下,變量名本身通常足以解釋變量的用途,此外,還需要額外的註釋。

解釋

根據場景和修改器的不同,變量可以分為很多類別。壹般來說,變量可以分為全局變量和局部變量。壹般來說,局部變量僅限於局部範圍,含義相對簡單易懂,只需要簡單的註釋。全局變量壹般作用於多個文件或者整個項目,所以它們的含義相對更復雜,所以在註釋的時候,最好把它們的具體含義描述清楚,也就是盡可能全面地描述。

拼音註釋

1.概觀

可能壹個變量或者壹個函數包含了非常復雜的意思,需要用多個單詞拼寫,所以對於拼寫需要詳細的註釋。

解釋

註釋通常被寫成完整的敘述性句子,具有正確的大寫和結尾句號。在大多數情況下,完整的句子比句子片段更具可讀性。較短的註釋,比如代碼行末尾的註釋,可以是任意的,但還是要註意風格的壹致性。同時,註釋中的拼寫和逗號也很重要。雖然在別人指出應該用分號的時候用逗號有些尷尬,但是清晰易讀的代碼還是很重要的,正確的標點、拼寫和語法會對此有很大的幫助。

TODO註釋

1.概觀

對於臨時的、短期的解決方案,或者足夠好但仍不完美的代碼,使用TODO註釋。

TODO註釋應該使用全大寫的字符串TODO,並在括號中寫下您的姓名、電子郵件地址、bug ID或其他標識以及與此TODO相關的問題。主要目的是讓添加評論的人(可以請求更多細節)根據標準的TODO格式進行搜索。添加TODO註釋並不意味著要自己去糾正,所以在添加帶名字的TODO時,壹般都是寫自己的名字。

  • 上一篇:小區物業鎖門違法嗎?
  • 下一篇:投資銀行監管原則
  • copyright 2024法律諮詢服務網