註釋及不同語言中的註釋
最近又學習了一門新語言,發現註釋和以往有很大差別,在下面簡單總結下注釋和目前流行的幾大高階語言如C、C++、C#、JAVA、python、MATLAB中的註釋,獻給初學者,歡迎補充>。<
關於高階語言中的註釋:
1、註釋是程式碼的“提示”或“解釋”而非文件;註釋主要用於解釋程式碼複雜度;註釋應準確、易懂(無二義性)、簡潔;程式中有效註釋量必須在20%以上。
說明:程式碼清楚可以自注釋的不需加註釋,過分詳細的註釋容易使人厭煩,切記不要自以為高深讓別人看不懂而不加註釋。
2、註釋的目的:為了便於程式碼的維護、解釋程式碼的功能和方法等方便讀者閱讀,以及防止不必要的重複資訊。
3、給程式碼添加註釋絕對是好習慣,最好邊寫程式碼邊註釋
C語言和C++中註釋情況一樣:
1、單行註釋:
//這是單行註釋
2、多行註釋:以“/”表示註釋開始,“/”表示註釋結束。
/*
我是
多行
註釋
*/
3、也可以進行組合,但不必要,格式儘量統一,最好都使用/…/
/*
//也是註釋
*/
4、說明:函式頭部應註釋,簡單扼要的列出函式的名稱、功能、呼叫關係、返回值、輸入、輸出引數等;變數、常量、最好宣告時進行註釋;陣列、類、列舉等等命名不是自注釋的,必須註釋。
JAVA:
1、有單行、多行和文件註釋,其中,單、多行註釋與c語言的相同。
2、文件註釋:
/**
文件註釋啦
*/
3、說明:由於在一些開發工具中,多行註釋格式化後效果不好,所以開發專案時儘可能使用單行註釋;另外,需要有開發工具支援才能更好地編寫文件註釋
快捷註釋(很多IDE都適用):Ctrl+/
Python:
快捷註釋:Ctrl+/(一般都適用,但IDLE好像不行)
和以往都不同,Python語言中單行註釋以#開頭
多行註釋以”’開頭,”’結尾(三個單引號)。
例如:
a,b=0,1
while a<1000: #這是單行註釋:輸出小於1000的元素
print(a,end=',')
a,b=b,a+b
'''
print('hello')
這是多行註釋,不被編譯器識別的
'''
MATLAB:
快捷註釋:
點選ctrl+R,註釋程式;可多次點選,多次註釋同一次選中的程式碼;
點選ctrl+T,取消註釋程式。
% 我是單行註釋
%{
我是多行註釋
啦啦啦
%}
if 0
我也可以多行註釋
啦啦啦
end
疊加也可以