技術(shù)規(guī)范知識(shí)84-文庫(kù)吧
2025-03-31 23:11 本頁面
【正文】 描述。簡(jiǎn)述用到的重要變量、結(jié)構(gòu)和文件等。d． 履歷描述。包括設(shè)計(jì)者、日期和版本，文件頭還包括版權(quán)聲名。功能性注釋嵌在源程序內(nèi)部用來描述處理功能。(6)輸入數(shù)據(jù)的檢查。所有輸入數(shù)據(jù)都應(yīng)經(jīng)過檢查。(7)變量使用前要賦初值。(8)錯(cuò)誤處理。一定要對(duì)可能出現(xiàn)的錯(cuò)誤進(jìn)行處理，以避免故障引起停機(jī)。（頭注釋）頭注釋可以大致分為文件注釋、模塊注釋、數(shù)據(jù)注釋等。在寫注釋時(shí)推薦使用以下格式。(1) 文件注釋（文件頭）,文件注釋記述以下信息 (a)文件識(shí)別信息175。 系統(tǒng)名（主模塊時(shí)）173。 程序名或模塊名173。 版本信息（包括時(shí)間）175。 所屬（從屬模塊時(shí)）173。 擔(dān)當(dāng)173。 著作權(quán)聲明(b)文件說明信息173。 簡(jiǎn)介175。 功能說明（主要模塊說明）175。 操作環(huán)境H/W，PLATFORM，OS，MEMORY等175。 編譯、連接信息make file名，命令過程文件名，編譯、連接選項(xiàng)（Option），應(yīng)連接的裝配模塊文件名，子程序庫(kù)名等(c) 文件維護(hù)信息版本，日期，作者所屬部門名，作者姓名，補(bǔ)充說明等173。 創(chuàng)建信息175。 更改記錄(d)其它175。 系統(tǒng)使用說明（主模塊時(shí)）175。 注意事項(xiàng)175。 文件管理工具的附加信息需要特別說明的信息175。 SYSTEM173。 PROGRAM/MODULE173。 VERSION175。 MASTER MODULE173。 AUTHOR173。 COPYRIGHT173。 ABSTRACT/PURPOSE175。 FUNCTION175。 ENVIRONMENT175。 MAKE OPTION173。 CREATE175。 UPDATE175。 USAGE175。 NOTE175。 SPECIAL INFO說明：“173?！北硎緲?biāo)準(zhǔn)項(xiàng)目，“175。”表示可選項(xiàng)目。(2) 模塊注釋（模塊頭）。模塊注釋對(duì)了解模塊的概要非常有效，而且在維護(hù)時(shí)也同樣有效，所以一定要記述。模塊注釋記述以下信息173。 模塊名175。 模塊編號(hào)175。 版本信息173。 簡(jiǎn)介175。 功能說明175。 影響175。 注意事項(xiàng)175。 返回值175。 參數(shù)說明175。 擔(dān)當(dāng)175。 創(chuàng)建信息175。 更改記錄173。 MODULE175。 ID175。 VERSION173。 ABSTRACT175。 FUNCTION175。 SIDEEFFECT175。 NOTE175。 RETURN175。 ARGUMENT175。 AUTHOR175。 CREATE175。 UPDATE說明：“173?！北硎緲?biāo)準(zhǔn)項(xiàng)目，“175?！北硎究蛇x項(xiàng)目。(3) 數(shù)據(jù)注釋數(shù)據(jù)注釋用來幫助對(duì)數(shù)據(jù)結(jié)構(gòu)或數(shù)據(jù)表、數(shù)組等內(nèi)容的理解。173。 標(biāo)識(shí)符名（用于標(biāo)識(shí)符定義）173。 數(shù)據(jù)結(jié)構(gòu)名稱173。 數(shù)據(jù)類型173。 簡(jiǎn)介175。 注意事項(xiàng)173。 TAG173。 DATA173。 DATATYPE173。 ABSTRACT175。 NOTE說明：“173?！北硎緲?biāo)準(zhǔn)項(xiàng)目，“175。”表示可選項(xiàng)目。附錄: 頭注釋樣例以下為C語言源文件的注釋樣例1. 主模塊文件頭（程序的主模塊，生成命令程序。）/***************************************************************//* *//* 系統(tǒng)： 系統(tǒng)名 *//* 用戶： 用戶名 *//*
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1