JAVA——程序員入門必備（代碼註釋）

這是我參與更文挑戰的第3天，活動詳情查看： 更文挑戰

編寫程序必定要寫的不單單是高效的代碼，註釋也是不可忽略的。
**一篇合格的源代碼裏至少包括1/3的註釋！**
複製代碼

爲何註釋如此重要呢？

那咱們首先要知道註釋是用來幹什麼的。註釋用來講明代碼的用途，能夠說明類的功能，方法的做用，變量的做用等等。

那爲何必定要寫註釋呢？由於當你思路通暢的時候，每每寫代碼很順利，但當你過一段時間後再來看本身曾經寫過的代碼時，你會發現？這是我寫的代碼？？？人的大腦是有限的，有極大地可能你已經看不懂當初本身寫的代碼了，毫無疑問這是一件很是痛苦的事，所以咱們剛開始就要養成寫註釋的好習慣。

java三種文檔註釋方式

1. 單行註釋

2.多行註釋 3.文檔註釋

單行註釋和多行註釋

單行註釋就是在這一行的開頭加上(//)
多行註釋就是在須要註釋的開頭加上（/*）,在結尾加上（*/）

例如：
public class Hello {
	/*這裏是多行註釋
	歡迎來到java世界！
	 */
	public static void main(String[] args){
		//System.out.println("這就是單行註釋");
	}
}

複製代碼

文檔註釋

java語言還提供了文檔註釋，它具備更增強大的功能！！！ 它經過JDK提供的javadoc工具能夠直接將源代碼裏的文檔註釋提取成爲一份系統的API文檔，能夠經過網頁打開。

說到API這應該是每一個程序員所必須會的技能，javaAPI包含了java各類類和方法的介紹使用，學會查看API對於咱們學習java有很大幫助，java中的類很是多，咱們不可能都記得住，當咱們不肯定或者忘記某些類的做用時，咱們就能夠打開API文檔來查詢類和類中包含方法的具體使用。

回到正題，文檔註釋格式是怎麼樣的呢? 文檔註釋以（/**）開始，以（*/）結束，中間都是文檔註釋的內容

public class Hello {
	/**
	 * 這裏是文檔註釋，是否是很簡單呢？
	 * @param args
	 */
         
	/*這裏是多行註釋
	歡迎來到java世界！
	 */
	public static void main(String[] args){
		//System.out.println("這就是單行註釋");
	}
}
複製代碼

那麼如何生成API文檔呢？

須要使用javadoc命令，基本語法格式以下。 javadoc 參數 java源文件/包 javadoc經常使用的參數有：

-d 文件夾；//用於指定目錄放置生成的API文件
-windowtitle 標題；//用於指定一個標題，做爲API文檔瀏覽窗口的標題
-doctitle 標題；//用於指定瀏覽器頁面的標題
-header 頁眉；//用於指定每一個頁面的頁眉

複製代碼

下圖是我生成的一個API文檔，你們也趕快去試試吧！

以上內容若有不對，歡迎你們指正。歡迎你們評論探討！
複製代碼