java程序工程規(guī)范(編輯修改稿)
2025-05-04 06:04 本頁面
【文章內(nèi)容簡介】 提供的工具就是解決這樣的問題，工具的引入，將程序員從枯燥然而又重要的工作中解放出來。程序員只要在書寫程序時按照一定的要求書寫注釋，將來就可用自動生成幫助文檔。程序員需要注意的規(guī)則如下：（）程序頭說明 注釋為“** 說明部分 *”,在說明部分一般包括文檔的標(biāo)題、描述、版權(quán)、作者、版本等信息。其中作者用 “ 作者”的形式體現(xiàn)，內(nèi)容和關(guān)鍵字之間用空格隔開。其他為 版本、 相關(guān)內(nèi)容或類、 本內(nèi)容在哪個版本以后開始出現(xiàn)。（）方法說明 用于說明本方法的主要用途，實現(xiàn)的基本思路，屬性信息有 屬性名稱 參數(shù)說明、 返回值說明、 例外說明、 異常類、 功能逐漸被淘汰說明。如果按照上面的方式書寫注釋，則它們可以反映到幫助文檔中?！纠?.*。 .
公司管理相關(guān)推薦
鄂ICP備17016276號-1