閱讀代碼編寫函數的說明_第1頁
閱讀代碼編寫函數的說明_第2頁
閱讀代碼編寫函數的說明_第3頁
閱讀代碼編寫函數的說明_第4頁
閱讀代碼編寫函數的說明_第5頁
已閱讀5頁，還剩7頁未讀， 繼續(xù)免費閱讀

下載本文檔

版權說明：本文檔由用戶提供并上傳，收益歸屬內容提供方，若內容存在侵權，請進行舉報或認領

文檔簡介

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

溫馨提示

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

評論

0/150

提交評論