首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
您现在的位置: 程式碼之家 >> 編程語言 >  >> Java 程式設計 >> Java 相關知識

Java 入門:從 HelloWorld 到 Javadoc 文檔生成全流程

     編輯:Java 相關知識

第一個 Java 程序

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}
  • 源文件名必須與 public class 同名(HelloWorld.java)
  • main 方法固定簽名:public static void main(String[] args)
  • Java 嚴格區分大小寫,關鍵字全小寫

三種註釋類型

Javadoc 標籤詳解

/**
 * 類說明
 * @author 作者名
 * @version 版本號
 * @see 參考鏈接
 */
public class Demo {
    /**
     * 方法說明
     * @param 參數名 參數說明
     * @return 返回值說明
     * @throws 異常類型 拋出條件
     * @deprecated 不推薦使用原因
     */
    public String method(String param) { ... }
}

生成 API 文檔

javadoc -d docs -author -version -encoding UTF-8 HelloWorld.java
  • -author/-version 包含作者版本標籤
  • 默認只提取 public/protected 成員,加 -private 包含私有成員
  • 輸出目錄 docs/ 下打開 index.html 查看

完整示例

package gee;
/**
 * 網站:作者博客
 * 程序名:Javadoc 演示
 * @author Gee
 * @version 1.0
 */
public class JavaDocDemo {
    /** 簡單測試字段 */
    protected String name;
    /** 主方法,程序入口 */
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}
  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved
類型語法用途
單行註釋// 註釋內容簡短說明
多行註釋/* 註釋內容 */塊級說明
文檔註釋/** 文檔內容 */生成 API 文檔,支持標籤