1.3 程序注釋
1.3.1程序注釋是程序員與日后的程序讀者之間通信的重要手段之一,注釋分為文件注釋、函數(shù)注釋和功能注釋。
1.3.2正規(guī)程序的注釋應(yīng)注意:
——注釋行的數(shù)量占到整個(gè)源程序的1/3到1/2。
1.3.3文件注釋位于整個(gè)源程序的最開始部分,注釋后空兩行開始程序正文。它包括:
——程序標(biāo)題。
——目的、功能說明。
——文件作者、最后修改日期等說明。
例:
./
(空一行)
標(biāo)題: Demo.c
功能: 測(cè)試VxWorks的各種系統(tǒng)調(diào)用。
說明:
該程序測(cè)試各種VxWorks的系統(tǒng)調(diào)用函數(shù)。包括任務(wù)(taks)的創(chuàng)建、掛起及任務(wù)間通過信號(hào)燈實(shí)現(xiàn)同步,通過消息隊(duì)列進(jìn)行通訊。
程序創(chuàng)建了兩個(gè)任務(wù):一個(gè)高優(yōu)先級(jí)的任務(wù)和一個(gè)低優(yōu)先級(jí)的任務(wù)。兩個(gè)任務(wù)間通過一個(gè)二進(jìn)制的信號(hào)燈進(jìn)行同步,通過消息隊(duì)列進(jìn)行通訊。
當(dāng)前版本: x.x
修改信息: 2000.06.05 John, Initial Version
2000.07.05 Tom, Bug xxxx fixed
/
(空2行,開始程序正文)
相關(guān)推薦:2011年上半年軟考報(bào)名時(shí)間預(yù)測(cè):2011年3月
2010年下半年軟考成績(jī)查詢時(shí)間及方式匯總
北京 | 天津 | 上海 | 江蘇 | 山東 |
安徽 | 浙江 | 江西 | 福建 | 深圳 |
廣東 | 河北 | 湖南 | 廣西 | 河南 |
海南 | 湖北 | 四川 | 重慶 | 云南 |
貴州 | 西藏 | 新疆 | 陜西 | 山西 |
寧夏 | 甘肅 | 青海 | 遼寧 | 吉林 |
黑龍江 | 內(nèi)蒙古 |