這一節學習了java程序的注釋。
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁,最大限度的提高團隊開發合作效率,如果說一個項目開發過程中項目組成員發生變動了,對于新來的成員很有幫助。也是程序代碼可維護性的重要環節之一。
所以我們不是為寫注釋而寫注釋。
首先講注釋的類型
繼續用1.4節的HolleWorld.java程序為例
~~~
/** ------------------------------------------------>這是文檔注釋
這個類是用于演示hello world.
*/
class HelloWorld{//-------------------------->這是單行注釋
/* ------------------------------------------->這是多選注釋
這是多行注釋
main函數可以保證該類的獨立運行.
它是程序的入口.
它會被JVM所調用
*/
public static void main(String[] args){
System.out.println("Hello World!");
}
}
~~~
從上面的代碼和注釋可以看到,java語言中的注釋主要可以分為三類
1.單行注釋: // ?
2.多選注釋(也稱為塊注釋):
/*
*/
3.文檔注釋:這個很重要,是java特有的注釋,自動生成文檔
/**
*/
4.javadoc 注釋標簽語法大體有以下幾種
@author 對類的說明標明開發該類模塊的作者
@version 對類的說明標明該類模塊的版本
@see 對類、屬性、方法的說明參考轉向,也就是相關主題
@param 對方法的說明對方法中某參數的說明
@return 對方法的說明對方法返回值的說明
@exception 對方法的說明對方法可能拋出的異常進行說明
javadoc可以幫助生成一個說明書,這個網頁文檔是給開發人員用的
注釋是不被編譯到class字節碼中.
注釋的作用:1注解說明;調試使用.
再來說下注釋的應用
在編程之前我們不要急著就開始編碼,先想一想我們要做什么,理一理我們應該怎么做,可以在編碼之前用注釋來記錄我們需求,思路,步驟等等,讓我們形成思考的好習慣。
/*
需求:
思路:
1.
2.
......
步驟:
1.
2.
......
*/
- 前言
- 1.1 基本常識
- 1.2 Java語言概述
- 1.3 Java語言的環境搭建
- 1.4 Java程序開發之初體驗--Hello World
- 2.1 關鍵字
- 2.2 標識符
- 2.3 注釋
- 2.4 常量
- 2.5 進制掃盲
- 2.6 變量和數據類型(1)
- 2.7 變量和數據類型(2)
- 2.8 運算符
- 3.1 if語句
- 3.2 switch語句
- 3.3 while和do-while語句
- 3.4 for語句
- 3.5 for循環的嵌套
- 3.6 break語句與continue語句
- 4.1 函數的定義
- 4.2 定義函數的兩個明確
- 4.3 函數的內存加載過程
- 4.4 函數的重載
- 5.1 數組的定義
- 5.2 數組的內存分配及特點
- 5.3 數組操作中常見問題
- 5.4 數組常用操作(1)
- 5.5 數組常用操作(2)
- 5.6 二維數組
- 6.1 面向對象的概述
- 6.2 類與對象的關系
- 6.3 對象的內存體現
- 6.4 成員變量與局部變量
- 6.5 類類型參數與匿名對象
- 6.6 基本數據類型參數與引用數據類型參數的傳遞過程
- 6.7 封裝
- 7.1 構造函數概述與默認構造函數
- 7.2 構造函數與一般函數的區別
- 7.3 構造函數的重載
- 7.4 構造函數的內存加載
- 7.5 構造函數需要注意的幾個細節
- 7.6 this關鍵字的原理
- 7.7 this關鍵字的細節與應用
- 8.1 static關鍵字之特點
- 8.2 成員變量與靜態變量的區別
- 8.3 static關鍵字使用的注意細節
- 8.4 main函數的解析與細節
- 8.5 static關鍵字的使用場景
- 8.6 靜態的內存加載
- 8.7 靜態代碼塊
- 8.8 構造代碼塊
- 9.1 繼承
- 9.2 單繼承與多重繼承
- 9.3 子父類中成員變量特征體現