java程式注釋

來源:互聯網
上載者:User
     Java程式有兩類注釋:實現注釋(implementation comments)和文檔注釋(document comments)。實現注釋是那些在C++中見過的,使用/*...*/和//界定的注釋。文檔注釋(被稱為"doc comments")是Java專屬的,由/**...*/界定。文檔注釋可以通過javadoc工具轉換成HTML檔案。
    實現注釋用以注釋代碼或者實現細節。文檔注釋從實現自由(implementation-free)的角度描述代碼的規範,用來給出代碼的總括,並提供代碼自身沒有提供的附加資訊。
    程式可有4種實現注釋的風格:塊(block)--塊注釋通常用於提供對檔案,方法,資料結構和演算法的描述;單行(single-line)--短注釋可以顯示在一行內,並與其後的代碼具有一樣的縮排層級;尾端(trailing)--極短的注釋可以與它們所要描述的代碼位於同一行;行末(end-of-line)--注釋界定符"//",可注釋掉整行或一行中的一部分
    文檔注釋描述Java的類、介面、構造器,方法,以及欄位(field)。每個文檔注釋都會被置於注釋定界符/**...*/之中,一個注釋對應一個類、介面或成員,位於聲明之前。
    更多有關文檔注釋和javadoc的詳細資料,參見javadoc的首頁: http://java.sun.com/javadoc/index.html
 

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.