欧美色欧美亚洲高清在线观看,国产特黄特色a级在线视频,国产一区视频一区欧美,亚洲成a 人在线观看中文

  1. <ul id="fwlom"></ul>

    <object id="fwlom"></object>

    <span id="fwlom"></span><dfn id="fwlom"></dfn>

      <object id="fwlom"></object>

      JAVA代碼注釋規(guī)范

      時間:2019-05-14 19:52:20下載本文作者:會員上傳
      簡介:寫寫幫文庫小編為你整理了多篇相關(guān)的《JAVA代碼注釋規(guī)范》,但愿對你工作學(xué)習(xí)有幫助,當然你在寫寫幫文庫還可以找到更多《JAVA代碼注釋規(guī)范》。

      第一篇:JAVA代碼注釋規(guī)范

      JAVA代碼注釋規(guī)范

      一、規(guī)范存在的意義

      1.好的注釋規(guī)范可以讓人一眼看明白這是干什么的,特別是對于我們這種行業(yè);共同合作完成一個項目需要分工明確,所以也需要有明了的注釋規(guī)范。

      2.正確的應(yīng)用注釋規(guī)范可以增加代碼的可讀性、理解性。3.好的代碼規(guī)范可以提高團隊的開發(fā)效率,從而節(jié)省時間。4.長期的堅持代碼規(guī)范可以讓程序員養(yǎng)成一個良好的習(xí)慣,甚至鍛煉出思維。

      二、命名規(guī)范

      1.一般概念

      1)盡量使用完整的英文描述。2)采用相對好理解的術(shù)語。

      3)采用駱駝命名的規(guī)范使名字增加可讀性。4)盡量少用縮寫提高可讀性。5)避免名字過長。

      6)避免使用類似的名字。7)避免使用特殊符號。2.主要的運用

      1)類(class)的命名

      2)接口(interface)的命名 +方法(method)的命名 3)參數(shù)(param)的命名

      三、注釋規(guī)范

      1.一般概念

      1)注釋應(yīng)該增加代碼的清晰度 2)保持代碼的整潔

      3)在寫代碼之前或同時注意寫上注釋

      4)注釋出為什么做這件事,做這件事的結(jié)果 2.注釋那些部分

      1)java文件:版權(quán)信息、創(chuàng)建時間、創(chuàng)建人 2)類:目的、所完成功能、版權(quán)信息、創(chuàng)建人 3)方法:參數(shù)含義、返回值 4)屬性:字段描述

      5)接口:目的、創(chuàng)建人、版本號、創(chuàng)建時間

      四、代碼格式規(guī)范

      1.單行注釋://注釋內(nèi)容,一般與代碼后空4-8格,注釋必須對齊 2.塊狀注釋:/*注釋內(nèi)容*/,一般是注釋從以/*開始,以*/結(jié)束中的所有內(nèi)容。3.文檔注釋:/**......*/所以注釋文 檔必須書寫在類、域、構(gòu)造函數(shù)、方法,以及字段(field)定義之前.注釋文檔由兩部分組成——描述、塊標記。4.javadoc注釋標簽

      @author 對類的說明 標明開發(fā)該類模塊的作者

      @version 對類的說明 標明該類模塊的版本

      @see 對類、屬性、方法的說明 參考轉(zhuǎn)向,也就是相關(guān)主題

      @param 對方法的說明 對方法中某參數(shù)的說明

      @return 對方法的說明 對方法返回值的說明

      @exception 對方法的說明 對方法可能拋出的異常進行說明

      五、java注釋具體實現(xiàn)

      1.源文件注釋

      /** *文件名 *創(chuàng)建人 *創(chuàng)建時間 *修改人 *描述 *版本號 */ 2.類注釋

      /** *對此類的描述信息 *創(chuàng)建人 *版本號 *創(chuàng)建時間 */ 3.方法的注釋

      /** *方法的用處 *該方法的參數(shù)列 *該方法返回的值 */ 4.屬性的注釋

      /** *字段的描述 */ 5.接口注釋

      /** *對此接口的描述 *創(chuàng)建人 *創(chuàng)建時間 *版本號 */ 6.構(gòu)造方法注釋

      /** *描述該構(gòu)造方法的用處 *該構(gòu)造方法的參數(shù)列 *參數(shù)的類型 */

      六、Jsp代碼格式規(guī)范

      1.多行注釋:,一般是注釋從以結(jié)束中的所有內(nèi)容。

      2.文本注釋:<%--內(nèi)容--%>,主要是對該頁面的一些描述,目的、創(chuàng)建人、創(chuàng)建時間、版本號、文件名、備注、修改人等.例如: <%---創(chuàng)建人-創(chuàng)建時間-版本號-文件名-備注-修改人--%> 3.偽劣標簽注釋:<% java語句塊 %> 例如: <% JAVA代碼塊 %> 4.單行注釋://注釋內(nèi)容,一般與代碼后空4-8格,注釋必須對齊

      七、JS代碼格式規(guī)范

      1.文本注釋:/** 注釋內(nèi)容 **/,主要是對該頁面的一些描述,目的、創(chuàng)建人、創(chuàng)建時間、版本號、文件名、備注、修改人等.也可以用于注釋代碼塊。例如: /** *創(chuàng)建人 *創(chuàng)建時間 *版本號 *文件名 *備注 *修改人 **/

      2.文本注釋:/** 內(nèi)容 */ ,主要是對該頁面的一些描述,目的、創(chuàng)建人、創(chuàng)建時間、版本號、文件名、備注、修改人等.也可以用于注釋代碼塊。例如: /** *創(chuàng)建人 *創(chuàng)建時間 *版本號 *文件名 *備注 *修改人 */ 3.單行注釋: //注釋內(nèi)容,一般與代碼后空4-8格,注釋必須對齊 4.多行注釋: /* 注釋內(nèi)容 */,一般是注釋從以/* 開始,以*/結(jié)束中的所有內(nèi)容。

      八、JS注釋具體實現(xiàn) 1.文件注釋

      /** *對此文件的描述信息 *創(chuàng)建人 *版本號 *創(chuàng)建時間 */ 2.方法的注釋

      /** *方法的用處 *該方法的參數(shù)列 *該方法返回的值 */ 3.模塊的注釋

      /** *模塊名稱

      *模塊的用處

      */

      第二篇:java注釋規(guī)范總結(jié)

      在軟件開發(fā)的過程中總是強調(diào)注釋的規(guī)范,但是沒有一個具體的標準進行說明,通常都是在代碼編寫規(guī)范中簡單的描述幾句,不能作為一個代碼注釋檢查的標準和依據(jù),做什么都要有一個依據(jù)嗎:),現(xiàn)在我特整理了一個《Java的注釋規(guī)范》,內(nèi)容來自網(wǎng)絡(luò)、書籍和自己的實際積累。

      JAVA注釋規(guī)范

      版本/狀態(tài) 作者 版本日期

      1.0 ghc 2008-07-02

      一、背景

      1、當我們第一次接觸某段代碼,但又被要求在極短的時間內(nèi)有效地分析這段代碼,我們需要什么樣的注釋信息?

      2、怎么樣避免我們的注釋冗長而且凌亂不堪呢?

      3、在多人協(xié)同開發(fā)、維護的今天,我們需要怎么樣的注釋來保證高質(zhì)、高交的進行開發(fā)和維護工作呢?

      二、意義

      程序中的注釋是程序設(shè)計者與程序閱讀者之間通信的重要手段。應(yīng)用注釋規(guī)范對于軟件本身和軟件開發(fā)人員而言尤為重要。并且在流行的敏捷開發(fā)思想中已經(jīng)提出了將注釋轉(zhuǎn)為代碼的概念。好的注釋規(guī)范可以盡可能的減少一個軟件的維護成本 , 并且?guī)缀鯖]有任何一個軟件,在其整個生命周期中,均由最初的開發(fā)人員來維護。好的注釋規(guī)范可以改善軟件的可讀性,可以讓開發(fā)人員盡快而徹底地理解新的代碼。好的注釋規(guī)范可以最大限度的提高團隊開發(fā)的合作效率。長期的規(guī)范性編碼還可以讓開發(fā)人員養(yǎng)成良好的編碼習(xí)慣,甚至鍛煉出更加嚴謹?shù)乃季S能力。

      三、注釋的原則

      1、注釋形式統(tǒng)一

      在整個應(yīng)用程序中,使用具有一致的標點和結(jié)構(gòu)的樣式來構(gòu)造注釋。如果在其他項目組發(fā)現(xiàn)他們的注釋規(guī)范與這份文檔不同,按照他們的規(guī)范寫代碼,不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。

      2、注釋的簡潔

      內(nèi)容要簡單、明了、含義準確,防止注釋的多義性,錯誤的注釋不但無益反而有害。

      3、注釋的一致性

      在寫代碼之前或者邊寫代碼邊寫注釋,因為以后很可能沒有時間來這樣做。另外,如果有機會復(fù)查已編寫的代碼,在今天看來很明顯的東西六周以后或許就不明顯了。通常描述性注釋先于代碼創(chuàng)建,解釋性注釋在開發(fā)過程中創(chuàng)建,提示性注釋在代碼完成之后創(chuàng)建。修改代碼的同時修改相應(yīng)的注釋,以保證代碼與注釋的同步。

      4、注釋的位置

      保證注釋與其描述的代碼相鄰,即注釋的就近原則。對代碼的注釋應(yīng)放在其上方相鄰或右方的位置,不可放在下方。避免在代碼行的末尾添加注釋;行尾注釋使代碼更難閱讀。不過在批注變量聲明時,行尾注釋是合適的;在這種情況下,將所有行尾注釋要對齊。

      5、注釋的數(shù)量

      注釋必不可少,但也不應(yīng)過多,在實際的代碼規(guī)范中,要求注釋占程序代碼的比例達到20%左右。注釋是對代碼的“提示”,而不是文檔,程序中的注釋不可喧賓奪主,注釋太多了會讓人眼花繚亂,注釋的花樣要少。不要被動的為寫注釋而寫注釋。

      6、刪除無用注釋 在代碼交付或部署發(fā)布之前,必須刪掉臨時的或無關(guān)的注釋,以避免在日后的維護工作中產(chǎn)生混亂。

      7、復(fù)雜的注釋

      如果需要用注釋來解釋復(fù)雜的代碼,請檢查此代碼以確定是否應(yīng)該重寫它。盡一切可能不注釋難以理解的代碼,而應(yīng)該重寫它。盡管一般不應(yīng)該為了使代碼更簡單便于使用而犧牲性能,但必須保持性能和可維護性之間的平衡。

      8、多余的注釋

      描述程序功能和程序各組成部分相互關(guān)系的高級注釋是最有用的,而逐行解釋程序如何工作的低級注釋則不利于讀、寫和修改,是不必要的,也是難以維護的。避免每行代碼都使用注釋。如果代碼本來就是清楚、一目了然的則不加注釋,避免多余的或不適當?shù)淖⑨尦霈F(xiàn)。

      9、必加的注釋

      典型算法必須有注釋。在代碼不明晰或不可移植處必須有注釋。在代碼修改處加上修改標識的注釋。在循環(huán)和邏輯分支組成的代碼中添加注釋。為了防止問題反復(fù)出現(xiàn),對錯誤修復(fù)和解決方法的代碼使用注釋,尤其是在團隊環(huán)境中。

      10、注釋在編譯代碼時會被忽略,不編譯到最后的可執(zhí)行文件中,所以注釋不

      會增加可執(zhí)行文件的大小。

      四、JAVA注釋技巧

      1、空行和空白字符也是一種特殊注釋。利用縮進和空行,使代碼與注釋容易區(qū)

      別,并協(xié)調(diào)美觀。

      2、當代碼比較長,特別是有多重嵌套時,為了使層次清晰,應(yīng)當在一些段落的結(jié)束處加注釋(在閉合的右花括號后注釋該閉合所對應(yīng)的起點),注釋不能

      寫得很長,只要能表示是哪個控制語句控制范圍的結(jié)束即可,這樣便于閱讀。

      3、將注釋與注釋分隔符用一個空格分開,在沒有顏色提示的情況下查看注釋時,這樣做會使注釋很明顯且容易被找到。

      4、不允許給塊注釋的周圍加上外框。這樣看起來可能很漂亮,但是難于維護。

      5、每行注釋(連同代碼)不要超過120個字(1024×768),最好不要超過80 字(800×600)。

      6、Java編輯器(IDE)注釋快捷方式。Ctrl+/ 注釋當前行,再按則取消注釋。

      7、對于多行代碼的注釋,盡量不采用“/*......*/”,而采用多行“//”注釋,這樣雖然麻煩,但是在做屏蔽調(diào)試時不用查找配對的“/*......*/”。

      8、注釋作為代碼切換開關(guān),用于臨時測試屏蔽某些代碼。

      例一:

      //*/

      codeSegement1;//*/

      改動第一行就成了:

      /*/

      codeSegement1;//*/ 例二:

      //----------------------第一段有效,第二段被注釋

      //*/

      codeSegement1;/*/

      codeSegement2;//*/

      只需刪除第一行的/就可以變成:

      //----------------------第一段被注釋,第二段有效

      /*/

      codeSegement1;/*/

      codeSegement2;//*/

      五、JAVA注釋方法及格式

      1、單行(single-line)--短注釋://??

      單獨行注釋:在代碼中單起一行注釋,注釋前最好有一行空行,并與其后的代碼具有一樣的縮進層級。如果單行無法完成,則應(yīng)采用塊注釋。

      注釋格式:/* 注釋內(nèi)容 */

      行頭注釋:在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。

      注釋格式:// 注釋內(nèi)容

      行尾注釋:尾端(trailing)--極短的注釋,在代碼行的行尾進行注釋。一般與代碼行后空8(至少4)個格,所有注釋必須對齊。

      注釋格式:代碼 + 8(至少4)個空格 + // 注釋內(nèi)容

      2、塊(block)--塊注釋:/*??*/ 注釋若干行,通常用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)等的意義與用途的說明,或者算法的描述。一般位于一個文件或者一個方法的前面,起到引導(dǎo)的作用,也可以根據(jù)需要放在合適的位置。這種域注釋不會出現(xiàn)在HTML報告中。注釋格式通常寫成:

      /*

      * 注釋內(nèi)容

      */

      3、文檔注釋:/**??*/

      注釋若干行,并寫入javadoc文檔。每個文檔注釋都會被置于注釋定界符

      /**......*/之中,注釋文檔將用來生成HTML格式的代碼報告,所以注釋文

      檔必須書寫在類、域、構(gòu)造函數(shù)、方法,以及字段(field)定義之前。注釋文檔由兩部分組成——描述、塊標記。注釋文檔的格式如下:

      /**

      * The doGet method of the servlet.* This method is called when a form has its tag value method

      * equals to get.* @param request

      * the request send by the client to the server * @param response

      * the response send by the server to the client * @throws ServletException * if an error occurred * @throws IOException * if an error occurred */

      public void doGet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {

      doPost(request, response);}

      前兩行為描述,描述完畢后,由@符號起頭為塊標記注釋。更多有關(guān)文檔注

      釋和javadoc的詳細資料,參見javadoc的主頁: http://java.sun.com/javadoc/index.html

      4、javadoc注釋標簽語法

      @author

      對類的說明 標明開發(fā)該類模塊的作者

      @version

      對類的說明 標明該類模塊的版本

      @see

      對類、屬性、方法的說明 參考轉(zhuǎn)向,也就是相關(guān)主題

      @param

      對方法的說明 對方法中某參數(shù)的說明

      @return

      對方法的說明 對方法返回值的說明

      @exception 對方法的說明 對方法可能拋出的異常進行說明

      六、JAVA注釋具體實現(xiàn)

      1、源文件注釋

      源文件注釋采用 /** ?? */,在每個源文件的頭部要有必要的注釋信息,包括:文件名;文件編號;版本號;作者;創(chuàng)建時間;文件描述包括本文件歷史修改記錄等。中文注釋模版:

      /**

      * 文 件 名 :

      * CopyRright(c)2008-xxxx: * 文件編號:

      * 創(chuàng) 建 人:

      * 日

      期:

      * 修 改 人:

      * 日

      期:

      * 描

      述:

      * 版 本 號:

      */

      2、類(模塊)注釋:

      類(模塊)注釋采用 /** ?? */,在每個類(模塊)的頭部要有必要的注釋信息,包括:工程名;類(模塊)編號;命名空間;類可以運行的JDK版本;版本號;作者;創(chuàng)建時間;類(模塊)功能描述(如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該類與其類的關(guān)系等,必要時還要有一些如特別的軟硬件要求等說明);主要函數(shù)或過程清單及本類(模塊)歷史修改記錄等。

      英文注釋模版:

      /**

      * CopyRright(c)2008-xxxx:

      <展望軟件Forsoft >

      * Project:

      <項目工程名 >

      * Module ID:

      <(模塊)類編號,可以引用系統(tǒng)設(shè)計中的類編號>

      * Comments: <對此類的描述,可以引用系統(tǒng)設(shè)計中的描述>

      * JDK version used:

      * Namespace:

      <命名空間>

      * Author:

      <作者中文名或拼音縮寫>

      * Create Date:

      <創(chuàng)建日期,格式:YYYY-MM-DD>

      * Modified By:

      <修改人中文名或拼音縮寫>

      * Modified Date: <修改日期,格式:YYYY-MM-DD>

      * Why & What is modified <修改原因描述>

      * Version:

      <版本號>

      */

      如果模塊只進行部分少量代碼的修改時,則每次修改須添加以下注釋:

      //Rewriter

      //Rewrite Date:<修改日期:格式Y(jié)YYY-MM-DD> Start1:

      /* 原代碼內(nèi)容*/ //End1:

      將原代碼內(nèi)容注釋掉,然后添加新代碼使用以下注釋:

      //Added by

      //Add date:<添加日期,格式:YYYY-MM-DD> Start2:

      //End2:

      如果模塊輸入輸出參數(shù)或功能結(jié)構(gòu)有較大修改,則每次修改必須添加以下

      注釋:

      //Log ID: //Depiction:<對此修改的描述> //Writer:修改者中文名

      //Rewrite Date:<模塊修改日期,格式:YYYY-MM-DD>

      2、接口注釋:

      接口注釋采用 /** ?? */,在滿足類注釋的基礎(chǔ)之上,接口注釋應(yīng)該包含描述接口的目的、它應(yīng)如何被使用以及如何不被使用,塊標記部分必須注明作者和版本。在接口注釋清楚的前提下對應(yīng)的實現(xiàn)類可以不加注釋。

      3、構(gòu)造函數(shù)注釋:

      構(gòu)造函數(shù)注釋采用 /** ?? */,描述部分注明構(gòu)造函數(shù)的作用,不一定有塊標記部分。

      注釋模版一:

      /**

      * 默認構(gòu)造函數(shù)

      */

      注釋模版二:

      /**

      * Description :

      帶參數(shù)構(gòu)造函數(shù),*

      初始化模式名,名稱和數(shù)據(jù)源類型

      * @param schema:

      模式名

      * @param name:

      名稱

      * @param type: 數(shù)據(jù)源類型

      */

      4、函數(shù)注釋:

      函數(shù)注釋采用 /** ??*/,在每個函數(shù)或者過程的前面要有必要的注釋信息,包括:函數(shù)或過程名稱;功能描述;輸入、輸出及返回值說明;調(diào)用關(guān)系及被調(diào)用關(guān)系說明等。函數(shù)注釋里面可以不出現(xiàn)版本號(@version)。

      注釋模版一:

      /**

      * 函 數(shù) 名 :

      * 功能描述:

      * 輸入?yún)?shù):

      <按照參數(shù)定義順序>

      *

      <@param后面空格后跟著參數(shù)的變量名字

      *

      (不是類型),空格后跟著對該參數(shù)的描述。> *

      * 返 回 值:-類型 <說明>

      *

      <返回為空(void)的構(gòu)造函數(shù)或者函數(shù),*

      @return可以省略;如果返回值就是輸入?yún)?shù),必須 *

      用與輸入?yún)?shù)的@param相同的描述信息;必要的時*

      候注明特殊條件寫的返回值。> * 異

      常:<按照異常名字的字母順序> * 創(chuàng) 建 人: * 日

      期: * 修 改 人: * 日

      期: */

      注釋模版二:

      /**

      * FunName:

      getFirstSpell

      * Description :

      獲取漢字拼音首字母的字符串,*

      被生成百家姓函數(shù)調(diào)用

      * @param:

      str the String是包含漢字的字符串

      * @return String:漢字返回拼音首字母字符串;

      *

      英文字母返回對應(yīng)的大寫字母;

      *

      其他非簡體漢字返回 '0';

      * @Author:

      ghc * @Create Date: 2008-07-02 */

      5、方法注釋:

      方法注釋采用 /** ?? */,對于設(shè)置(Set 方法)與獲取(Get 方法)成員的方法,在成員變量已有說明的情況下,可以不加注釋;普通成員方法要求說明完成什么功能,參數(shù)含義是什么且返回值什么;另外方法的創(chuàng)建時間必須注釋清楚,為將來的維護和閱讀提供寶貴線索。

      6、方法內(nèi)部注釋:

      控制結(jié)構(gòu),代碼做了些什么以及為什么這樣做,處理順序等,特別是復(fù)雜的邏輯處理部分,要盡可能的給出詳細的注釋。

      7、全局變量注釋:

      要有較詳細的注釋,包括對其功能、取值范圍、哪些函數(shù)或者過程存取以及存取時注意事項等的說明。

      8、局部(中間)變量注釋:

      主要變量必須有注釋,無特別意義的情況下可以不加注釋。

      9、實參/參數(shù)注釋:

      參數(shù)含義、及其它任何約束或前提條件。

      10、字段/屬性注釋: 字段描述,屬性說明。

      11、常量:常量通常具有一定的實際意義,要定義相應(yīng)說明。

      第三篇:代碼注釋格式

      ////////////////////////////////////////////////////////////////////////// //函數(shù)名稱: WriteFile //函數(shù)功能: 向加密鎖創(chuàng)建文件,并且向文件中寫入數(shù)據(jù),注意寫入的數(shù)據(jù)不宜過大,最好少于2k為最佳 //參數(shù)說明: fileSize: 文件的大小,以字節(jié)為單位 // fileID: 文件在加密鎖中的ID, // fileName: 文件在加密鎖中的名字 // fileContent: 文件內(nèi)容

      //返 回 值: 如果寫入文件成功,則返回true,如果寫入文件失敗,則返回false.//作 者: luyao ///////////////////////////////////////////////////////////////

      第四篇:java文件頭注釋格式

      myeclipse中java文件頭注釋格式設(shè)置

      2011-10-08 13:11:33| 分類: IDE|舉報|字號 訂閱

      windows->preferences->java->Code Templates->comments->Type->edit Eclipse注釋規(guī)范模版總結(jié) 新建類文件 /** * @ClassName: ${file_name} * @Description: ${todo}(用一句話描述該文件做什么)* * @author ${user} * @version V1.0 * @Date ${date} ${time} */ 方法 /** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個方法的作用)* @param: ${tags} * @return: ${return_type} * @throws * @author ${user} * @Date ${date} ${time} */

      輸入設(shè)置模板:

      /** * ${file_name} Create on ${date} * * Copyright(c)${date} by taotaosoft * * @author Jerryli * @version 1.0 * */

      注意選擇自動添加注釋

      養(yǎng)成一個規(guī)范的習(xí)慣是最好的。

      選菜單 windows-->preference Java-->Code Style-->Code Templates code-->new Java files

      選中點編輯

      ${filecomment} ${package_declaration} /** * @author 作者姓名 E-mail: email地址 * @version 創(chuàng)建時間:${date} ${time} * 類說明 */ ${typecomment} ${type_declaration}

      Eclipse注釋規(guī)范模版總結(jié)

      1、具體操作

      (1)在eclipse中,打開Window->Preference->Java->Code Style->Code Template(2)然后展開Comments節(jié)點就是所有需設(shè)置注釋的元素,參照2注釋規(guī)范對應(yīng)設(shè)置即可

      2、注釋規(guī)范

      (1)文件(Files)注釋標簽 /** * FileName: ${file_name} * @Description: ${todo}(用一句話描述該文件做什么)* All rights Reserved, Designed By ZTE-ITS * Copyright: Copyright(C)2010-2011 * Company ZTE-ITS WuXi LTD.* @author: 名字 * @version V1.0 * Createdate: ${date} ${time} * * Modification History: * Date Author Version Discription * * ${date} wu.zh 1.0 1.0 * Why & What is modified: <修改原因描述> */

      (2)類型(Types)注釋標簽(類的注釋):

      /** * @ClassName: ${type_name} * @Description:${todo}(這里用一句話描述這個類的作用)* @author: Android_Robot * @date: ${date} ${time} * * ${tags} */

      (3)字段(Fields)注釋標簽:

      /** * @Fields ${field} : ${todo}(用一句話描述這個變量表示什么)*/

      (4)構(gòu)造函數(shù)標簽:

      /** * @Title: ${enclosing_type} * @Description: ${todo}(這里用一句話描述這個方法的作用)* @param: ${tags} * @throws */

      (5)方法(Methods)標簽:

      /** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個方法的作用)* @param: ${tags} * @return: ${return_type} * @throws */

      (6)覆蓋方法(Overriding Methods)標簽: /** *

      Title: ${enclosing_method}

      *

      Description:

      * ${tags} * ${see_to_overridden} */

      (7)代表方法(Delegate Methods)標簽: /** * ${tags} * ${see_to_target} */

      (8)getter方法標簽:

      /** * @Title: ${enclosing_method}
      * @Description: please write your description
      * @return: ${field_type}
      */

      (9)setter方法標簽:

      /** * @Title: ${enclosing_method}
      * @Description: please write your description
      * @return: ${field_type}
      */ ren

      第五篇:java流實驗內(nèi)容及代碼

      實驗7 流(2學(xué)時)

      一、實驗?zāi)康?.熟悉流類庫中各種常用流的使用方法。

      2.能夠使用流類實現(xiàn)基本的文件讀寫。

      二、實驗內(nèi)容

      1.編寫程序,在控制臺窗口提示輸入兩個整數(shù),然后接收這兩個整數(shù),并輸出它們的和。(要求:鍵盤輸入通過流封裝System.in獲取,不要使用Scanner類)

      import java.io.*;System.out.println(x);System.out.println(“y”);public class Num1 {n=in.readLine();public static void main(String []args)y=Integer.parseInt(n);{System.out.println(y);int x=0,y=0;}catch(IOException e)BufferedReader in=new BufferedReader({

      newSystem.out.println(“error”);InputStreamReader(System.in));}

      String n;int s=x+y;

      try{System.out.println(s);System.out.println(“x”);}

      n=in.readLine();}

      x=Integer.parseInt(n);

      2.設(shè)計學(xué)生類Student,屬性:編號(整型);姓名(字符串),成績(整型)。編寫一個程序:要求:(1)輸入3個學(xué)生的姓名和成績,將其姓名和成績保存到data.txt中;(2)然后從該文件中讀取數(shù)據(jù),求得這三個學(xué)生的平均成績。

      import java.io.*;DataOutputStream dout = newDataOutputStream(public class num2 {newpublic static void main(String[]args)FileOutputStream(“D:data.txt”));{String n;

      BufferedReader in=new BufferedReader(for(int i=0;i<5;i++)new{

      InputStreamReader(System.in));n=in.readLine();

      int num=Integer.parseInt(n);try{String name=in.readLine();

      n=in.readLine();int grade=Integer.parseInt(n);dout.writeBytes(num+“rn”);dout.writeBytes(name+“rn”);dout.writeBytes(grade+“rn”);}dout.close();}catch(IOException e1){int num=Integer.parseInt(n);

      n=din.readLine();String name=n;n=din.readLine();int grade=Integer.parseInt(n);ave+=grade;}System.out.println(“平均成績”+ave*1.0/5);System.out.println(“文件寫入失敗”);}try{DataInputStream din =new DataInputStream(new FileInputStream(“D:data.txt”));int ave=0;String n;for(int i=0;i<5;i++){n=din.readLine();

      三、實驗要求

      完成程序設(shè)計并提交實驗報告。

      在“);失敗”);} }

      }catch(FileNotFoundException e){System.out.println(“文件不存}catch(IOException e2){System.out.println(”文件讀取}

      下載JAVA代碼注釋規(guī)范word格式文檔
      下載JAVA代碼注釋規(guī)范.doc
      將本文檔下載到自己電腦,方便修改和收藏,請勿使用迅雷等下載。
      點此處下載文檔

      文檔為doc格式


      聲明:本文內(nèi)容由互聯(lián)網(wǎng)用戶自發(fā)貢獻自行上傳,本網(wǎng)站不擁有所有權(quán),未作人工編輯處理,也不承擔(dān)相關(guān)法律責(zé)任。如果您發(fā)現(xiàn)有涉嫌版權(quán)的內(nèi)容,歡迎發(fā)送郵件至:645879355@qq.com 進行舉報,并提供相關(guān)證據(jù),工作人員會在5個工作日內(nèi)聯(lián)系你,一經(jīng)查實,本站將立刻刪除涉嫌侵權(quán)內(nèi)容。

      相關(guān)范文推薦

        學(xué)術(shù)論文注釋規(guī)范

        學(xué)術(shù)論文注釋規(guī)范 一、文后參考文獻及其隨文夾注格式 參考文獻按在正文中出現(xiàn)的先后次序列于文末,以“參考文獻:”(左頂格)作為標識。參考文獻的序號左頂格,并用數(shù)字加方括號表......

        參考文獻及注釋規(guī)范

        一、基本概念 (1)“注釋”指作者進一步解釋自己所要表達的意思,注釋安排在當頁頁腳,用帶圈數(shù)字表示序號,如注①、注②等,注釋的序號與文中序號一一對應(yīng)。 (2)“參考文獻”指作者引文......

        C# 注釋規(guī)范

        C# 注釋(Comment)規(guī)范 注釋規(guī)范包括:模塊(類)注釋規(guī)范、類的屬性、方法注釋規(guī)范、代碼間注釋 1. 模塊(類)注釋規(guī)范 模塊開始必須以以下形式書寫模塊注釋: /// ///模塊編號: ///作用......

        學(xué)術(shù)論文注釋規(guī)范

        注釋的格式 (一)中文注釋: 1、當文章引用或借用的資料所在的著作第一次出現(xiàn)于注釋中時,須將該書作者姓名、書名、出版地、出版者、出版年代及引用資料所在的頁碼一并注出。(1)引......

        注釋、參考文獻格式規(guī)范

        注釋: 1、丁有寬.丁有寬小學(xué)語文讀寫結(jié)合法[M].濟南:山東教育出版社,1999:52. 2、岑波平.隨文練筆請不要隨意而作——小學(xué)語文課堂小練筆略談[J].新課程學(xué)習(xí),2009,(4):182. 3、......

        Java命名規(guī)范

        Java包的名字都是由小寫單詞組成。但是由于Java面向?qū)ο缶幊痰奶匦?,每一名Java程序員都可以編寫屬于自己的Java包,為了保障每個Java包命名的唯一性,在最新的Java編程規(guī)范中,要求......

        代碼編寫規(guī)范5篇

        代碼編寫規(guī)范 1、 所有代碼排版整齊,可以使用編程工具自帶的排版功能; 2、 代碼縮進使用Tab鍵,不允許使用空格; 3、 標示符的聲明:修飾符與變量名之間留一空格; 4、 用途相近的變......

        Web前端代碼規(guī)范

        龍圖教育,全球游戲50強教育品牌004km.cn Web前端代碼規(guī)范 此項目用于記錄規(guī)范的、高可維護性的前端代碼,這是通過分析 Github 眾多前端代碼庫,總結(jié)出來的前端代碼書......