程式註解說明

2 程式註解格式 塊狀註解 對檔案、 class 、 method 、資料結構、一段程式 …. 等程式區塊 做說明。 第一行的開頭必需為 “/*” 且沒有其他文字，最後一行的開頭 必需以 “*/” 做為結束，在中間每一行的開頭都必需是一個 “*” 。 單行註解 佔據一整行的說明。 以 “//” 標示開頭。 行末註解 放在被註解的程式行末，是很短的註解。 以 “//” 帶頭。

3 檔案註解範例 /* (include version) *Description: */

4 Class 註解範例 /** and Date: *Description: */

5 其它區塊註解 範例 1: 使用於說明變數或需特別說明之區塊 /** * Here is a example program. */ 範例 2: 使用於說明 constructor, method /** *Description: * 變數名稱, 說明內容 說明回傳之意義 */ 空一行

6 其它區塊註解範例 /** * To check if the input is integer number * n is to receive the input value to check if it is integer. -1 if this number is not a integer * 1 otherwise */ boolean isInteger(int n){ }

7 單行及行末註解範例 void main() { char name[20]; //user’s name //get input stream and store into name[] cin.getline(name, 20); }

8 程式縮排 為增進程式本身的可讀性，程式敘述（含宣告）應有適 當的縮排，並以反映程式敘述的結構及邏輯性為原則 縮排以四個空白字元為單位 ( 或將 TAB 設定為 4 個空白字元 ) 每一行不超過 80 個字元，當一行放不下時，應適當斷句 for(int i=0; i<10; i++) { for(int j=0; j<10;j++) { cout <<" …………" << endl; }