C 語言中的注釋
編程語言的注釋是為了程序員維護代碼而出現的。注釋內容其本身并不參與程序的編譯與執行,注釋的出現只是為了記錄一些文本信息而出現的。
在自由軟件出現后,注釋的更為重要的功能就是聲明軟件的授權使用協議。這在除我國在外的,其他很多國家具有法律效力。
1. C 語言的注釋標準
C 語言的注釋目前有兩種:
- 多行注釋(經典式注釋)
- 單行注釋(C++ 式注釋)
1.1 多行注釋
以 /* 注釋內容 */
形式出現的注釋。注釋可以寫在一行,也可以跨越多行。只要在注釋的開始使用 /*
標明,在注釋全部寫完后用 */
結束就可以了。被這兩組符號包圍的部分就是注釋主體。
/* 注釋的示范程序
可以跨越多行進行注釋
*/
/**************************************
為了強調可以這樣標注,可以寫很長的注釋體。
一般自由軟件會有很長的授權協議寫在開頭,
大家使用別人軟件的時候請仔細閱讀。
***************************************/
# include <stdio.h>
int main()
{
/* 聲明變量 */
int x,y,z;
return 0; /* 返回值 */
}
1.2 單行注釋
但是如果不使用 IDE ,而使用鍵盤敲擊注釋內容,每次都要敲擊 4 次鍵盤才能完成一次注釋,對于一些簡短的注釋來說是比較麻煩的。
因此在 C++ 語言設計的時候,就出現了使用 //
來進行單行注釋的方法。請注意,這里編譯器只會忽略 //
后面到本行行末的部分。也就是只能注釋一行。這與使用 /* */
方式注釋可以同時注釋多行的方式有所不同。這種注釋的方法優缺點顯而易見。與上面的傳統方式優勢互補。
Tips:需要特別注意的是,對于幾十年前的老舊的編譯器,這種注釋方式會引起錯誤。當然,最近十年的編譯器已經可以支持這種新的注釋標準了。
# include <stdio.h>
int main()
{
// 聲明變量
int x,y,z;
return 0; // 返回值
}
將兩種注釋方式混合使用的例子。
/*
使用第一種方式注釋
*/
# include <stdio.h>
int main()
{
// 使用第二種方式注釋
int x,y,z;
return 0;
}
2. 小結
對于 C 語言的注釋,這里有兩種方式:
- 多行注釋(經典式注釋)
- 單行注釋(C++ 式注釋)
經典式可以注釋多行,使用 /* */
來進行注釋,而 C++ 式的注釋提供了更為便捷的注釋方式,只能注釋單行,使用 //
進行注釋。大家可以根據實際需要選擇。但是要切記,作為一個程序員良好的素養就是做好注釋。沒有注釋的程序是不完整的程序,因為程序閱讀的對象是人。