從HelloWorld和文檔注釋開始入門Java編程_java

來源:互聯網
上載者:User

HelloWorld

public class HelloWorld{  public static void main(String args[])  {  System.out.println("Hello World!");  //向控制台輸出一條語句,同時必須以;結尾  }   }

運行上面程式如圖所示

我們通過上面的程式開始分析並學習Java語言的基礎知識;

1、注釋:

      Java的注釋分為三種:單行注釋//  多行注釋/*…*/  文檔注釋

      像上面的HelloWorld程式分別用到了多行注釋和單行注釋。

       Java還提供了另外一種注釋叫文檔注釋,如果編寫Java原始碼時添加了合適的文檔注釋,然後通過JDK提供的javadoc工具可以直接將原始碼裡的文檔注釋提取成一份系統的API文檔。API文檔就是用以說明應用程式介面的文檔。對於Java而言,API文檔通常說細說明了每個類、每個方法的功能及用法。

       Java語言的API文檔的下載地址:http://www.oracle.com/technetwork/java/javase/downloads/index.html

   關於文檔注釋,我會在後面專門有一篇文章

2、Java的組織形式

//Java程式必須是以類class形式存豐,類class是Java程式的最小程式單位class 類名{ /*Java解譯器規定:如需某個類能被解譯器直接解釋執行,則這個類必須包含main方法,而且main方法必須使用pulbic static void來修飾,且main方法的形參必須是字串數群組類型(String args[]是字串數組的形式) 也就是說main方法基本上固定不變的*/  public static void main(String args[])  {   }   }

3、Java源檔案的命名規則
    1)Java程式源檔案的尾碼必須是.java,不能是其他檔案尾碼名

    2)一個Java源檔案可以包含多個類定義,但最多隻能包含一個public類定義;如果Java源檔案裡包含public類定義,則該源檔案的檔案名稱必須與這個public類的類名相同

    3)Java語言是嚴格區分大小寫語言。因為源檔案的檔案名稱儲存的時候也應注意大小寫

    4)Java程式中的關鍵字全部是小寫

總結:通過上面的程式簡單地說了一下Java程式的架構結構。

文檔注釋

Java語言提供了一種功能更強大的注釋形式:文檔注釋。如果編寫Java原始碼時添加了合適的文檔注釋,然後通過JDK提供的javadoc工具可以直接將原始碼裡的文檔注釋提取成一份系統的API文檔。API是應用程式介面的意思,API是Java提供的基本編程介面,當使用Java語言進行編程時,不可能把所有的Java類、所有方法全部記下來,那麼如果我們遇到一個不確定的地方時,必須通過API文檔來查看某個類、某個方法的功能和用法。

Java API文檔的下載地址:http://www.oracle.com/technetwork/java/javase/downloads/index.html

下載完成之後,開啟DOCS/api檔案夾裡面的index.html檔案,

1、API文檔首頁如圖

2、類說明區格局如下圖

由於只有以public或protected修飾的內容才是希望暴露給別人使用的內容,而API文檔主要是向使用者提供資訊,因此javadoc工具預設只處理public或protected修飾的內容。如果開發人員確實希望javadoc工具可以提取private修飾的內容,則可以在使用javadoc工具時增加-private選項來實現

下面我們通過一個示範程式來說明文檔注釋

package Gee;/** 網站:<a href="http://www.geeit.me/">作者部落格站</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工具產生更詳細的文檔資訊,例如為方法參數、方法傳回值等產生詳細的說明資訊,則可利用javadoc標記。常用的javadoc標記如下。

  •   @author:指定程式的作者 
  •   @version:源檔案的版本
  •   @deprecated:不推薦使用的方法
  •   @param:方法的參數說明資訊
  •   @return:方法的傳回值說明資訊
  •   @see: “參見”用於指定交叉參考的內容
  •   @exception:拋出異常的類型
  •   @throws:拋出的異常,和exception同義。

javadoc工具預設不會提取@author和@version兩個標記資訊,如果需要提取這兩個標記應該使用javadoc工具指定的-author和-version兩個版本

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在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.