文章責編:張曉1
看了本文的網(wǎng)友還看了學歷| 高考 中考 考研 自考 成考 外語| 四六級 職稱英語 商務英語 公共英語 資格| 公務員 報關員 銀行 證券 司法 導游 教師 計算機| 等考 軟考
工程|一建 二建 造價師 監(jiān)理師 咨詢師 安全師 結構師 估價師 造價員 會計| 會計證 會計職稱 注會 經(jīng)濟師 稅務師 醫(yī)學| 衛(wèi)生資格 醫(yī)師 藥師 [更多]
1.3 程序注釋
1.3.1程序注釋是程序員與日后的程序讀者之間通信的重要手段之一,注釋分為文件注釋、函數(shù)注釋和功能注釋。
1.3.2正規(guī)程序的注釋應注意:
——注釋行的數(shù)量占到整個源程序的1/3到1/2。
1.3.3文件注釋位于整個源程序的最開始部分,注釋后空兩行開始程序正文。它包括:
——程序標題。
——目的、功能說明。
——文件作者、最后修改日期等說明。
例:
./
(空一行)
標題: Demo.c
功能: 測試VxWorks的各種系統(tǒng)調用。
說明:
該程序測試各種VxWorks的系統(tǒng)調用函數(shù)。包括任務(taks)的創(chuàng)建、掛起及任務間通過信號燈實現(xiàn)同步,通過消息隊列進行通訊。
程序創(chuàng)建了兩個任務:一個高優(yōu)先級的任務和一個低優(yōu)先級的任務。兩個任務間通過一個二進制的信號燈進行同步,通過消息隊列進行通訊。
當前版本: x.x
修改信息: 2000.06.05 John, Initial Version
2000.07.05 Tom, Bug xxxx fixed
/
(空2行,開始程序正文)
相關推薦:北京 | 天津 | 上海 | 江蘇 | 山東 |
安徽 | 浙江 | 江西 | 福建 | 深圳 |
廣東 | 河北 | 湖南 | 廣西 | 河南 |
海南 | 湖北 | 四川 | 重慶 | 云南 |
貴州 | 西藏 | 新疆 | 陜西 | 山西 |
寧夏 | 甘肅 | 青海 | 遼寧 | 吉林 |
黑龍江 | 內蒙古 |