源代碼格式不對,也是軟件錯誤。
源代碼是軟件的一個重要的組成部分,源代碼格式不對,換句話說,源代碼錯誤,肯定是軟件錯誤。所以,把源代碼編譯沒有錯誤等價為源代碼正確,是錯誤的,把運行沒有錯誤,等價為源代碼正確,是錯誤的。
源代碼格式的幾點應該注意的事項(常識):
1、源代碼的書寫格式,應該體現源代碼內部的邏輯關系;
2、源代碼內部最重要的代碼行是:空行;空行把代碼分成各個相對獨立的組成部分;
3、源代碼內部第二重要的代碼行是:注釋行;
4、源代碼行內最重要的字符是:空格;空格把代碼行分成各個相對獨立的組成部分;
5、源代碼行內第二重要的字符是:制表符(Tab),制表符是行首縮進使用的字符;
6、注釋合格的標準是:同等級技術能力的技術人員,可用比較方便的看懂代碼;或者,應該從事該工作的技術人員可以容易的看懂;
7、注釋行數應該占到總代碼行數的三分之一;
8、每個源代碼文件頭部都必須有說明本文件功能的注釋;
9、自己定義的每個函數都必須有說明函數功能的注釋;
10、自己定義的每個變量都必須有說明變量功能的注釋;
11、注釋應該使用自己的母語(漢語);
12、一句注釋合格的標準是,表達了需要表達的內容,語法正確;
13、清楚的注釋能夠方便代碼閱讀者理解代碼的邏輯關系和各個函數的功能;
14、鍵盤上最重要的鍵是空格鍵,空格占英文文章的比例是20%左右;寫軟件源代碼時,空格的比例也很大;所以,鍵盤上面積最大的鍵是空格;
posted on 2007-04-18 09:08
石正 閱讀(505)
評論(1) 編輯 收藏