閱讀代碼編寫函數(shù)的說(shuō)明_第1頁(yè)
閱讀代碼編寫函數(shù)的說(shuō)明_第2頁(yè)
閱讀代碼編寫函數(shù)的說(shuō)明_第3頁(yè)
閱讀代碼編寫函數(shù)的說(shuō)明_第4頁(yè)
閱讀代碼編寫函數(shù)的說(shuō)明_第5頁(yè)
已閱讀5頁(yè),還剩7頁(yè)未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說(shuō)明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

定相關(guān)代碼程序代碼注釋編寫的編地方都加了,注釋不宜太多也不能太少,注釋語(yǔ)言必的文字都視等)頭部應(yīng)進(jìn)行注釋,注釋必須列出:版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、內(nèi)志等,頭文件的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要標(biāo)準(zhǔn),當(dāng)然,并不局限于此格式,但上述COPYRIGHTCMicTiVoInternationalCoLtdFileNAME://文件AuthorVersion:Date:期DESCRIPTION詳細(xì)說(shuō)明此程序文件完成的主要功能,與其他模塊值、取值范圍、含義及參數(shù)間的控或依賴等關(guān)系Others:FunctionList函數(shù)列表,每條記錄應(yīng)包括函數(shù)名及功能簡(jiǎn)要說(shuō)明y1.Date:Author:Modification:2.../:版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、模塊目標(biāo)準(zhǔn),當(dāng)然,并不局限于此格式,但上述COPYRIGHTCMicTiVoInternationalCoLtdFileNameAuthor:VersionDateDESCRIPTION://模塊描述,描述本文件的內(nèi)容、功能、內(nèi)部各系及系等Version:ionList1.-------History:/值、調(diào)用關(guān)系(函數(shù)、表)等。,當(dāng)然,并不局限于此格式,但上述信息數(shù)名稱DESCRIPTION函數(shù)功能、性能等的描述Calls:函數(shù)清單CalledBy:清單TableAccessed://被訪問(wèn)的表(此項(xiàng)僅對(duì)于牽扯到數(shù)據(jù)庫(kù)操作的程序)TableUpdated://被修改的表(此項(xiàng)僅對(duì)于牽扯到數(shù)據(jù)庫(kù)操作的程序)Input:每個(gè)參數(shù)的作明Others:/其功能、取值范圍、哪些函數(shù)或過(guò)程存取收失敗,1—接收成功,2—*/cessta作時(shí),需注明該寄存器功能,配置參數(shù)作用,以及配置時(shí)的注意事項(xiàng)等的說(shuō)明。示例:(PIC單片機(jī)定時(shí)器控制)voidtimeinitvoidTCONXNxcRHxaaMRLxaa(初級(jí)程序員討論版)證。清晰、規(guī)范的源程序不僅僅查錯(cuò)誤,提高調(diào)試效率,從而最終保證軟件的歡迎指正。本文檔主要適用于剛剛開始接每個(gè)函數(shù)的定義和說(shuō)明應(yīng)該從第1列開始書寫。函數(shù)名(包括參數(shù)表)和函數(shù)體的花括號(hào)(“{”和“}”)應(yīng)該各占一行。在函數(shù)體結(jié)尾的括號(hào)(“}”)后面數(shù)名,這樣比較方便進(jìn)行括號(hào)配對(duì)檢查,也可以寫時(shí),操作符號(hào)應(yīng)該放在行末,而不b對(duì)齊。例如:參數(shù)表折行后,下面1.5嵌套語(yǔ)句(語(yǔ)句塊)的格式對(duì)于嵌套式的語(yǔ)句--即語(yǔ)句塊(如,if、while、switch等)應(yīng)該包括在花括一行,并與關(guān)鍵字對(duì)齊。建議即使語(yǔ)句塊中只有,這樣可以使程序結(jié)構(gòu)更清晰,也可以避免出。{}}}else{容。對(duì)于程序中復(fù)雜的部分必須有注釋加以語(yǔ)言中使用一組(/**/)作為注釋界定符。注釋內(nèi)容盡量用英語(yǔ)方式表述。**塊注釋*/*/該使用注釋加以說(shuō)明。對(duì)于一個(gè)以說(shuō)

溫馨提示

  • 1. 本站所有資源如無(wú)特殊說(shuō)明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論