程式碼註釋規範
1.檔案註釋
檔案註釋寫在文件頭部,以/*開頭,例:
/ *
* 檔名:[檔名]
* 作者:〈版權〉
* 描述:〈描述〉
* 修改人:〈修改人〉
* 修改時間:YYYY-MM-DD
* 修改內容:〈修改內容〉
*/
2.類和介面的註釋
說明該類或者介面的功能、作用、使用方法和注意事項,每次修改後增加作者和更新版本號和日期
/ *
* 〈一句話功能簡述〉
* 〈功能詳細描述〉
* @author [作者]
* @version [版本號, YYYY-MM-DD]
* @see [相關類/方法]
* @since [產品/模組版本]
* @deprecated
*/
3.成員變數
註釋內容:成員變數的意義、目的、功能,可能被用到的地方。用//來註釋,需要對齊被註釋程式碼。
4.公有和保護方法
註釋內容:列出方法的一句話功能簡述、功能詳細描述、輸入引數、輸出引數、返回值、違例等。
注意事項:
1.邊寫程式碼邊註釋,修改程式碼同時修改相應的註釋,以保證註釋與程式碼的一致性。不再有用的註釋要刪除。
2.避免在註釋中使用縮寫,特別是不常用縮寫。說明:在使用縮寫時或之前,應對縮寫進行必要的說明。 註釋應該放在被註釋的程式碼前面,分行展示,但中間不留空行。
相關推薦
Idea-Java程式碼註釋規範
IDEA自帶的註釋模板不是太好用,我本人到網上搜集了很多資料系統的整理了一下製作了一份比較完整的模板來分享給大家(如果嫌配置繁瑣,可以在本頁面最下方下載jar包,匯入idea,就可以了)。 一、首先我們來設定IDEA中類的模板:(IDEA中在建立類時會自動給添加註釋)
PHP程式碼註釋規範
PHPDocumentor是一個用PHP寫的工具,對於有規範註釋的php程式,它能夠快速生成具有相互參照,索引等功能的API文件。老的版本是 phpdoc。 1. 什麼是phpDocumentor ? PHPDocumentor 是一個用PHP寫的工具,對於有規範註釋的php程式,它能
程式碼註釋規範
1.檔案註釋 檔案註釋寫在文件頭部,以/*開頭,例: / * * 檔名:[檔名] * 作者:〈版權〉 * 描述:〈描述〉 * 修改人:〈修改人〉 * 修改時間:YYYY-MM-DD * 修改內容:〈修改內容〉 */ 2.類和介面的註釋 說明該類或者介面的功能、作用、使用方法和
java程式碼註釋規範(二)
一、背景 1、當我們第一次接觸某段程式碼,但又被要求在極短的時間內有效地分析這段程式碼,我們需要什麼樣的註釋資訊? 2、怎麼樣避免我們的註釋冗長而且凌亂不堪呢? 3、在多人協同開發、維護的今天,我們需要怎麼樣的註釋來保證高質、高交的進行開發和維護工作呢? 二、意義
程式碼註釋規範(2)
2 註釋規範要求下面以C++中的標頭檔案為例來說明如何進行註釋,以及註釋要求。注意:由於blog顯示原因,把其中的pre1改為pre,把b1改為b,刪掉[註釋*]字樣。/** * @file example.h[註釋1] * @brief 這是一個註釋格式說明檔案[
Java&Android程式碼註釋規範
一、註釋及簡介 1、鄙人寫的一些程式碼中,雖說有註釋,但都是一些不符合規則的註釋,即便拿出來查閱,也要花很一些時間才能搞懂程式的流程。為了良好的程式設計風格,我特意學習了java的文件註釋,也分享給大家,良好的程式設計風格確實很重要,不可忽略··· 2、說一
【風宇衝】Unity3D教程寶典之 C#程式碼註釋規範及文件生成
原為地址:http://blog.sina.com.cn/lsy835375 C#程式碼註釋規範及文件生成 在使用c#進行Unity3D遊戲開發中,良好的註釋和文件能讓開發更有效率,條理更清晰。 本講分為兩個部分: 一:編寫註釋 二: 生成文件
程式碼註釋規範-IDEA 配置 Java 類方法註釋模板
1. 引言 團隊開發時,業務模組分配的越清晰,程式碼註釋管理越完善,越有利於後面維護,後面再管理也方便不少。另外也起著"文字磚"的作用,你懂的。註釋不需要很詳細,把程式碼塊方法塊功能簡述一下就行。不然三月後回頭看就要罵人了,罵完發現是自己寫的,嘖嘖嘖... 三種常用的 Ja
Html、CSS、JS程式碼註釋的規範總結
新增必要的註釋,對一個有責任心、有道德模範的前端必須具備的好習慣,可以大大提高程式碼的可維護性、可讀性。 首先熟悉一下html、css、js的註釋的寫法: 1、HTML註釋語法: <!--註釋的內容--> 2、css註釋語法 /* 註釋內容 */
給php程式碼新增規範的註釋
在phpdocumentor中,註釋分為文件性註釋和非文件性註釋。所謂文件性註釋,是那些放在特定關鍵字前面的多行註釋,特定關鍵字是指能夠被phpdoc分析的關鍵字,例如class,var等,具體的可參加附錄1.那些沒有在關鍵字前面或者不規範的註釋就稱作非文件性註釋,這些註
ActionScript中的程式碼註釋常用的ASDoc規範
優美的註釋是優美程式碼的重要組成部分。好的註釋不僅可以讓別人快速理解程式碼,部分語言還可以用註釋生成對應的html文件,在不看原始碼的情況下快速瞭解框架,或後期的具體查詢。熟悉Java 的程式猿都知道Javadoc,不知用ActionScript的程式
給php程式碼新增規範的註釋phpDocumentor
給php程式碼新增規範的註釋在phpdocumentor中,註釋分為文件性註釋和非文件性註釋。所謂文件性註釋,是那些放在特定關鍵字前面的多行註釋,特定關鍵字是指能夠被phpdoc分析的關鍵字,例如class,var等,具體的可參加附錄1.那些沒有在關鍵字前面或者不規範
自動化測試代碼註釋規範
online *** drive 成員 文檔自動生成 pan studio stl get 原文鏈接:http://www.cnblogs.com/zishi/p/6857606.html 一、頁頭加入代碼說明塊,格式如下: /******************
JAVA編程規範-註釋規範
應用 進行 ava line 而不是 信息 font 意義 控制 1.【強制】類、類屬性、類方法的註釋必須使用 Javadoc規範,使用/**內容*/格式,不得使用//xxx方式。說明:在 IDE編輯窗口中,Javadoc方式會提示相關註釋,生成 Javadoc可以正確輸出
MyEclipse,Eclipse註釋規範模板
tag javadoc edit 新建 ram tor 公司 函數 method 註釋的作用:myeclipse中java文件頭註釋格式設置,最終可用於javadoc.exe生成API文檔,同時提高了代碼的可讀性 設置方法: windows->preferences-
Python 中的註釋規範
空格 這樣的 有關 info 參數 self none ise ger 在Python中,分為單行註釋,多行註釋,特殊註釋 特殊註釋: #!/usr/bin/env python 這樣的註釋意思是:Python告訴LINUX 去哪個路徑下找Python的翻譯器
C/C++註釋規範
\n bool IE 說明文 介紹 orm right 之間 組合 C/C++註釋規範 Doxygen是一種開源跨平臺的,以類似JavaDoc風格描述的文檔系統,完全支持C、C++、Java、Objective-C和IDL語言,部分支持PHP、C#。鑒於Doxygen良好的
JSDoc 註釋規範
@class doc gpo final alert get getjson str link 命令名描述 @param @argument 指定參數名和說明來描述一個函數參數@returns 描述函數的返回值@author 指示代碼的作者@deprecated 指示一個
標準註釋規範
author param 類型 介紹 語句 多行 nbsp AC code 常見註釋規範 1、文件頭的註釋,介紹文件名,功能以及作者版本號等信息 /** *文件名簡單介紹 * *文件功能。 * @author zwesy作者 * @version
#程式設計師吐槽阿里程式碼不規範!網友:慢了績效就沒了
一個優秀的開發工程師,他的技術不僅要達到相對靠前的標準,而且平常的程式設計格式也應該要規範,比如程式碼對齊、巢狀等等,這些都是老生常談的話題了,不需要去強調! 有想學習java的程式設計師,可來我們的java學習扣qun:72340,3928免費送java的視訊教程噢!小編是6年java開發