C 語言初學教材 - 第一章 註解

簡單的例子的程式碼如下

#include <stdio.h>

int main(void)
{
    int month, day, hour, min;
    char *name;
    
    month = 7;
    day = 27;
    hour = 9;
    min = 45;
    name = "kaiching";
    
    printf("\n\n今天是 %d 月 %d 日\n", month, day);
    printf("現在是上午 %d:%d\n", hour, min);
    printf("哈囉, %s！\n\n", name);
    
    return 0;
}

/* 《程式語言教學誌》的範例程式
    http://pydoing.blogspot.com/
    檔名：csimple.c
    功能：簡單顯示訊息的例子
    作者：張凱慶
    時間：西元2010年7月 */

我們把注意力放到第 21 到 26 行，也就是下圖中的註解 (comment) 區



註解就是用為輔助的說明文字，編譯器編譯時會忽略所有的註解文字。我們在簡單例子中所提供的註解為有關程式的整體資訊，小程式也許不太需要註解就能讀懂，但是當程式發展越來越大的時候，也就是動輒數百到數千、數萬行之時，適當的註解有助於程式後續的發展及維護。


通常軟體開發團隊會有既定的註解模式，諸如哪些地方、什麼時候等等，我們提供的註解是站在教學立場，以提供輔助說明為主。


C 語言的註解方式有兩種，第一種如簡單例子，利用一組斜線加星號 /* ，然後一直到另一組星號加斜線為止 */

/* 註解第一行 */
/* 註解第二行 */
/* 註解第三行 */

這種方式也可跨行

/* 註解第一行
   註解第二行
   註解第三行 */

也可加在任何程式碼之前或之後

int month, day, hour, min; /* 宣告為整數型態的變數 */
/* 注意，這是指標 */ char *name;

第二種方式為連用兩個斜線 //

// 註解第一行
// 註解第二行
// 註解第三行

這只能做單行的註解，同時只能放在無程式碼的單行或程式碼之後

int month, day, hour, min; // 宣告為整數型態的變數 
// 注意，這是指標 char *name;

上例中的字元型態的指標變數 name 被註解化了，因此編譯時會發生錯誤。


註解化可作為發展程式時一種進行測試的技巧，例如除錯時不確定錯誤發生的地方，可將該處先註解化，然後先進行編譯，看是否能編譯成功，以期順利找出錯誤的地方。

問題與討論

1. C 語言有哪兩種註解的方式？
2. 註解的功能是什麼？什麼情況需要註解呢？
3. 若將程式碼全部註解化，編譯時會發生什麼事呢？

來寫程式吧

• 前置處理
• 註解
• 函數
• 變數、宣告與關鍵字
• 常數與指派
• 呼叫
• 回傳
• 程式碼的編排

回 C 初學教材
回 C 教材目錄
回首頁