從HelloWorld和文檔注釋開始入門Java編程
HelloWorld
public class HelloWorld { public static void main(String args[]) { System.out.println("Hello World!"); //向控制臺輸出一條語句,同時必須以;結(jié)尾 } }
運(yùn)行上面程序如圖所示
我們通過上面的程序開始分析并學(xué)習(xí)Java語言的基礎(chǔ)知識;
1、注釋:
Java的注釋分為三種:單行注釋// 多行注釋/*…*/ 文檔注釋
像上面的HelloWorld程序分別用到了多行注釋和單行注釋。
Java還提供了另外一種注釋叫文檔注釋,如果編寫Java源代碼時添加了合適的文檔注釋,然后通過JDK提供的javadoc工具可以直接將源代碼里的文檔注釋提取成一份系統(tǒng)的API文檔。API文檔就是用以說明應(yīng)用程序接口的文檔。對于Java而言,API文檔通常說細(xì)說明了每個類、每個方法的功能及用法。
Java語言的API文檔的下載地址:http://www.oracle.com/technetwork/java/javase/downloads/index.html
關(guān)于文檔注釋,我會在后面專門有一篇文章
2、Java的組織形式
//Java程序必須是以類class形式存豐,類class是Java程序的最小程序單位 class 類名 { /*Java解釋器規(guī)定:如需某個類能被解釋器直接解釋執(zhí)行,則這個類必須包含main方法,而且main方法必須使用pulbic static void來修飾,且main方法的形參必須是字符串?dāng)?shù)組類型(String args[]是字符串?dāng)?shù)組的形式) 也就是說main方法基本上固定不變的 */ public static void main(String args[]) { } }
3、Java源文件的命名規(guī)則
1)Java程序源文件的后綴必須是.java,不能是其他文件后綴名
2)一個Java源文件可以包含多個類定義,但最多只能包含一個public類定義;如果Java源文件里包含public類定義,則該源文件的文件名必須與這個public類的類名相同
3)Java語言是嚴(yán)格區(qū)分大小寫的語言。因為源文件的文件名保存的時候也應(yīng)注意大小寫
4)Java程序中的關(guān)鍵字全部是小寫的
總結(jié):通過上面的程序簡單地說了一下Java程序的框架結(jié)構(gòu)。
文檔注釋
Java語言提供了一種功能更強(qiáng)大的注釋形式:文檔注釋。如果編寫Java源代碼時添加了合適的文檔注釋,然后通過JDK提供的javadoc工具可以直接將源代碼里的文檔注釋提取成一份系統(tǒng)的API文檔。API是應(yīng)用程序接口的意思,API是Java提供的基本編程接口,當(dāng)使用Java語言進(jìn)行編程時,不可能把所有的Java類、所有方法全部記下來,那么如果我們遇到一個不確定的地方時,必須通過API文檔來查看某個類、某個方法的功能和用法。
Java API文檔的下載地址:http://www.oracle.com/technetwork/java/javase/downloads/index.html
下載完成之后,打開DOCS/api文件夾里面的index.html文件,
1、API文檔首頁如圖
2、類說明區(qū)格局如下圖
由于只有以public或protected修飾的內(nèi)容才是希望暴露給別人使用的內(nèi)容,而API文檔主要是向使用者提供信息,因此javadoc工具默認(rèn)只處理public或protected修飾的內(nèi)容。如果開發(fā)者確實希望javadoc工具可以提取private修飾的內(nèi)容,則可以在使用javadoc工具時增加-private選項來實現(xiàn)
下面我們通過一個演示程序來說明文檔注釋
package Gee; /** 網(wǎng)站:<a >作者博客站</a> <br/>這是一個javadoc工具演示的程序 <br/>程序名:javadoc演示程序 <br/>程序文件名:JavaDocDemo @author Gee @version 1.0 */ public class JavaDocDemo { /** 簡單的測試Field */ protected String name; /** 主方法,程序的入口 */ public static void main(String[] args) { System.out.println("Hello World!"); } }
除此之外,如果我們希望 javadoc工具生成更詳細(xì)的文檔信息,例如為方法參數(shù)、方法返回值等生成詳細(xì)的說明信息,則可利用javadoc標(biāo)記。常用的javadoc標(biāo)記如下。
- @author:指定程序的作者
- @version:源文件的版本
- @deprecated:不推薦使用的方法
- @param:方法的參數(shù)說明信息
- @return:方法的返回值說明信息
- @see: “參見”用于指定交叉參考的內(nèi)容
- @exception:拋出異常的類型
- @throws:拋出的異常,和exception同義。
javadoc工具默認(rèn)不會提取@author和@version兩個標(biāo)記信息,如果需要提取這兩個標(biāo)記應(yīng)該使用javadoc工具指定的-author和-version兩個版本
相關(guān)文章
springboot下mybatis-plus開啟打印sql日志的配置指南
這篇文章主要給大家介紹了關(guān)于springboot下mybatis-plus開啟打印sql日志的配置指南的相關(guān)資料,還介紹了關(guān)閉打印的方法,文中通過實例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-03-03SpringBoot 在項目啟動之后執(zhí)行自定義方法的兩種方式小結(jié)
這篇文章主要介紹了SpringBoot 在項目啟動之后執(zhí)行自定義方法的兩種方式小結(jié),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09spring事務(wù)隔離級別、傳播機(jī)制以及簡單配置方式
這篇文章主要介紹了spring事務(wù)隔離級別、傳播機(jī)制以及簡單配置方式,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2021-01-01JDBC連接SQL?Server數(shù)據(jù)庫實現(xiàn)增刪改查的全過程
實際開發(fā)中手動的輸入SQL語句是少之又少,大多數(shù)情況下是通過編譯代碼進(jìn)行來控制自動執(zhí)行,下面這篇文章主要給大家介紹了關(guān)于JDBC連接SQL?Server數(shù)據(jù)庫實現(xiàn)增刪改查的相關(guān)資料,需要的朋友可以參考下2023-04-04SpringBoot實現(xiàn)統(tǒng)一封裝返回前端結(jié)果集的示例代碼
在實際項目開發(fā)過程中,我們經(jīng)常將返回數(shù)據(jù)的基本形式統(tǒng)一為JSON格式的數(shù)據(jù)。但項目可能是由很多人開發(fā)的,所以我們最好將返回的結(jié)果統(tǒng)一起來。本文介紹了SpringBoot實現(xiàn)統(tǒng)一封裝返回前端結(jié)果集的示例代碼,需要的可以參考一下2022-06-06Java基礎(chǔ)知識之ByteArrayOutputStream流的使用
這篇文章主要介紹了Java基礎(chǔ)知識之ByteArrayOutputStream流的使用,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-12-12