你可能知道java代碼編寫規範,但是你知道Javadoc文檔注釋規範嗎?

2020-08-27 Java從入門到架構師

我們編寫一個完整的Java程序,這個程序內容非常簡單,就是列印一下當前日期,示例如下:

import java.util.*;

public class Hello {

public static void main(String[] args){

System.out.println(new Date());

}

}



以上示例中,import主要用來引入額外的類。通常我們需要引入jdk裡面的類,我們可以在sun官網,查找JDK文檔,來查看所有JDK內置的類。

上面我們用到的Date類是位於java.util這個路徑下面的。System.out.println()這個方法主要用來列印數據到控制臺,而且列印完了後換行。

Java類的名稱必須和文件的名稱保持一致,如果這個類要編譯和獨立運行的話,還必須包含main()方法,這裡用到的main方法是public static void main(String[] args){}。其中public的意思是,任意外部類都可以調用這個方法。而且示例中,main方法有一個String數組類型的參數args,這個參數主要用來存儲命令行參數,所以必須有。



System.out.println(new Date());

這句代碼中,當Date對象創建後,它就會被發送到println(),而且當Date對象被使用完後,將被垃圾回收期自動回收,無需我們去清理。

Java有很多標準的類庫集,比如;

public class Hello2 {

public static void main(String[] args){

System.getProperties().list(System.out);

System.out.println(System.getProperty(「java.library.path」));

System.out.println(System.getProperty(「user.name」));

}

}

System.getProperties().list(System.out);這句代碼可以給你提供環境信息,在控制臺輸出所有系統信息。

System.out.println(System.getProperty(「java.library.path」));這句代碼將大約系統屬性java.library.path(java類庫的位置)。

System.out.println(System.getProperty(「user.name」));這句代碼將大約用戶名信息。



我們編寫完Java程序後,我們如果要運行,就必須先大家Java開發環境,首先我們需要在java.sun.com這個網站下載JDK,然後進行安裝,並且配置環境變量信息(具體可以百度),最終我們要確保計算機知道java和javac這兩個文件的位置。然後我們在程序的當前目錄中打開命令行,輸入:

javac Hello.java

就可以執行Hello.java這個程序了。

java語言中,一般有兩種注釋代碼的方式,一種是/*開頭,*/結尾,中間的地方會被注釋掉。示例如下:

/*

代碼

*/

另一種是//開頭,這個注釋符號會注釋掉當前一整句代碼。示例如下:

//代碼

還有一種特殊的方式,就是說明注釋,開始以 /** ,結束以 */。這種說明注釋允許嵌入程序信息,從而可以使用javadoc等工具生成文檔注釋,一般是HTML格式。

代碼文檔主要用來說明代碼,java中通過javadoc這個工具來提取代碼中的注釋,從而形成文檔。這個工具輸出一個HTML文件,然後我們就可以在瀏覽器中查看文檔內容了。

java文檔注釋會識別一些特殊的標籤,常用的有@author,@exception,@param,@return,@version,@see等等。示例如下:

/** 這個類繪製一個條形圖

* @author runoob

* @version 1.2

*/

上面示例中,第一行/**後面跟著通常是類、欄位和方法的描述信息,之後的@標籤後面跟內容,前面需要加上*號。

eclipse和idea都可以在工具內生成Javadoc注釋文檔。

使用JAVA語言編寫程序,需要注意一些規範,常用的有:

1、 類的名稱首字母需要大寫,如果類名稱由多個單詞組成,需要用駝峰命名法;

2、 欄位和方法的名稱首字母需要小寫,如果名稱由多個單詞組成,也需要使用駝峰命名法。

相關焦點

  • JavaDoc注釋與幫助說明文檔
    我們知道在java中注釋有三種,第一種,單行注釋 //注釋的內容,第二種,多行注釋 /*…注釋的內容…*/,第三種 文檔注釋 /**..注釋的內容….*/。不難發現,第三種注釋方式和第二種方式很相似,那它出現的目的是什麼呢?就是為了便於javadoc程序自動生成文檔。
  • JAVA注釋詳解以及實戰應用
    概述幾乎所有程式語言都允許程式設計師在代碼中輸入注釋(comment),編譯器會忽略注釋的內容。因此,注釋不會影響程序的運行結果。注釋的真正作用是:它可以向任何閱讀代碼的人描述或者解釋程序的實現思路、如何使用以及其他任何相關信息。
  • Java 架構 -Java 代碼規範那些事
    Java開發中所要遵守的編碼規範大體上有如下7點。命名規範、注釋規範、縮進排版規範、文件名規範、聲明規範、語句規範以及編程規範。「//」;對於所有的javadoc的注釋則使用「/** /」;而臨時對代碼塊進行注釋儘量使用「/ */」。
  • 「Java」基礎06:編寫入門程序
    Java程序開發三步驟:編寫,編譯,運行一、編寫即開發人員編寫Java原始碼。新建一個記事本,命名為HelloWorld,再將後綴名.txt改變成.java。用記事本打開HelloWorld.java文件,代碼如下:這樣寫完,HelloWorld程序原始碼就編寫好了。
  • Python編寫代碼的規範要求
    打開APP Python編寫代碼的規範要求 碼農阿勇 發表於 2020-01-16 17:44:00 在我們日常生活中,做什麼事情講究規矩,當然我們寫程序也不例外,也是有規範的。
  • Java開發代碼編寫規範有哪些
    在使用Java語言編寫代碼時,我們知道有很多Java代碼規範需要遵循,但有些學習Java的學生總是忘記,也有很多Java學生不屑遵守,心裡在想,只要我的Java代碼OK,符合代碼規範,有什麼問題嗎?編寫Java開發代碼有哪些規範呢?
  • XDoc-Java 1.1.0 發布,Java 純注釋生成接口文檔工具
    增加對JFinal的支持3.應大眾要求,增加@paramObj注釋標籤支持4.優化markdown格式輸出XDoc 基於Java注釋的接口文檔工具 基於java注釋生成接口文檔-對代碼無侵入,無需註解,純代碼注釋 支持SpringWeb, SpringBoot, JFinal 文檔輸出格式支持
  • 「JavaSE」Java的注釋全解
    註解簡介Java的註解分為三類:單行注釋多行注釋文檔注釋1.1 單行注釋概述:就是在程序中注釋一行代碼語法:將雙斜槓【//】放在需要注釋的內容之前就可以了。1.2 多行注釋概述:將程序中的多行注釋一次性的注釋掉語法 :/* 注釋文字 */1.3 文檔注釋概述:文檔注釋就是通過JDK提供的javadoc工具嗎,將原始碼中的文檔注釋內容提取成一份程序的API文檔。
  • 零基礎小白必看篇:Python代碼注釋規範代碼實例解析操作(收藏)
    本文內容主要介紹了Python代碼注釋規範代碼實例解析,通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下!!!一、代碼注釋介紹注釋就是對代碼的解釋和說明,其目的是讓人們能夠更加輕鬆地了解代碼。
  • smart-doc 1.8.5 發布,Java 零註解文檔生成工具
    smart-doc是一個java restful api文檔生成工具, smart-doc完全基於接口源碼分析來生成接口文檔,完全做到零註解侵入
  • 這篇代碼規範及工具使用,全網火了
    代碼規範,是為確保軟體代碼能被系統正確運行,軟體編寫者或其他參與者能正確理解、維護軟體代碼,換句話說,就是增強代碼的易用性、可讀性、可維護性、安全性等要求。業界公認的代碼規範手冊(國內)當屬阿里巴巴旗下出版的《阿里巴巴java開發手冊》,經過幾個版本的迭代,最新手冊為《「碼出高效」 阿里巴巴java開發手冊1.4.0版本》,更新時間為2018年5月20號。
  • Google 官方Java 編碼規範
    其他的術語說明會偶爾在後面的文檔出現。1.2 指南說明本文檔中的示例代碼並不作為規範。也就是說,雖然示例代碼是遵循Google編程風格,但並不意味著這是展現這些代碼的唯一方式。 示例中的格式選擇不應該被強制定為規則。
  • smart-doc 1.7.7 發布,Java 零註解文檔生成工具
    smart-doc 完全基於接口源碼分析來生成接口文檔,完全做到零註解侵入,你只需要按照java標準注釋的寫,smart-doc 就能幫你生成一個簡易明了的 Markdown、Html、AsciiDoc 文檔。如果你已經厭倦了 swagger 等文檔工具的無數註解和強侵入汙染,那請擁抱 smart-doc吧!
  • Java代碼開發規範
    參考相關文檔及總結命名風格代碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束。包名統一使用 單數形式,但是類名如果有複數含義,類名可以使用複數形式。 正例:應用工具類包名為 com.xjgx.util、類名為 MessageUtils規範縮寫,望文知義。 反例:AbstractClass「縮寫」成 AbsClass;condition「縮寫」成 condi;Function 縮寫」成 Fu,此類 隨意縮寫嚴重降低了代碼的可閱讀性。
  • 軟體工程師編程過程是否需要一份項目規範的技術文檔?
    作為軟體工程師,我們都知道作用是解決技術問,開始項目時刻你可能立即跳近編寫代碼裡面,如果你開始編程項目代碼之前,不考慮項目編程問題的解決方案,那你可能不是一位負責人的軟體工程師。你可以通過編寫技術文檔規範來思考工作中常見的技術問題,編寫技術文檔規範會增加獲項目的成功速度,減少了在實施編程代碼過程中出現嚴重錯誤的概率,因為你通過編寫技術文檔規範來鞏固技術知識或項目開發進展、時間表。
  • smart-doc 1.7.8 發布,Java 零註解文檔生成工具
    smart-doc 完全基於接口源碼分析來生成接口文檔,完全做到零註解侵入,你只需要按照java標準注釋的寫,smart-doc 就能幫你生成一個簡易明了的 Markdown、Html、AsciiDoc 文檔,當然還支持生成直接導入Postman的接口json文檔。如果你已經厭倦了 swagger 等文檔工具的無數註解和強侵入汙染,那請擁抱 smart-doc吧!
  • [評論]為什麼谷歌要執行嚴格的代碼編寫規範
    譯文來自外刊IT評論《為什麼谷歌要執行嚴格的代碼編寫規範》。本篇是谷歌是如何做代碼審查的的續篇。文章內容如下:我堅信這些規範都是官僚制度下產生的浪費大家的編程時間、影響人們開發效率的東西。我是大錯特錯了。在谷歌,我可以查看任何的代碼,進入所有谷歌的代碼庫,我有權查看它們。事實上,這種權限是很少人能擁有的。但是,讓我感到驚訝的卻是,如此多的編碼規範—縮進,命名,文件結構,注釋風格—這一切讓我出乎意料的輕鬆的閱讀任意一段代碼,並輕易的看懂它們。這讓我震驚—因為我以為這些規範是微不足道的東西。
  • smart-doc 1.9.4 發布,Java 零註解 API 文檔生成工具
    smart-doc完全基於接口源碼分析來生成接口文檔,完全做到零註解侵入,你只需要按照java標準注釋編寫,smart-doc就能幫你生成一個簡易明了的markdown 或是一個像GitBook樣式的靜態html文檔。如果你已經厭倦了swagger等文檔工具的無數註解和強侵入汙染,那請擁抱smart-doc吧!
  • smart-doc 1.9.9 發布,Java 零註解 API 文檔生成工具
    smart-doc是一款同時支持java restful api和apache dubbo rpc接口文檔生成的工具,smart-doc顛覆了傳統類似swagger這種大量採用註解侵入來生成文檔的實現方法
  • 高質量Java開發:編碼規範和代碼樣式
    【IT168 技術】  規範統一的編碼會增加項目代碼的可讀性和可維護性,但實際情況往往是項目組內的 Java 代碼開發人員的編碼風格常常各不相同,這可能是由於不同的經驗習慣或者缺乏編碼規範方面的學習造成的。