java開發文檔編寫

1. java api介面文檔怎麼編寫

Java語言提供了一種強大的注釋形式：文檔注釋。可以將源代碼里的文檔注釋提取成一份系統的API文檔。我們在開發中定義類、方法時可以先添加文檔注釋，然後使用javadoc工具來生成自己的API文檔。

文檔注釋以斜線後緊跟兩個星號（/**）開始，以星號後緊跟一個斜線（*/）作為結尾，中間部分全部都是文檔注釋，會被提取到API文檔中。

自行搜索一下javadoc即可，示例如下：

/** * 類描述 * * @author 作者 * @version 版本 */public class DemoClass { /** * 內部屬性：name */ private String name; /** * Setter方法 * @return name */ public String getName() { return name; } /** * Getter方法 * @param name */ public void setName(String name) { this.name = name; } }

2. java面試官問有沒有寫過文檔（面試java程序員）,我想知道寫文檔是指什麼,是設計文檔還是需求文檔還是其他

我想他的文檔是指在項目開發過程中 不同階段的文檔

我們項目組開發基本是基於瀑布模型開發 每個階段都會輸出文檔指導後續工作開展
一般se下發需求後 由我們出 詳細需求設計文檔
代碼開發完成了 轉測試時我們會寫 資料庫設計文檔 ，操作手冊 (這個也算)
還有就是 版本升級說明書 版本功能清單 軟體介紹
這個是大概的文檔 還有其他的...文檔編寫時間 主要是代碼開發前 與 轉測試後

3. java 項目需求文檔要怎麼寫

5.在線預覽、分享更便捷

在摹客中在線撰寫或上傳的產品需求文檔，可通過鏈接快速分享給團隊成員，團隊成員獲得鏈接後可自由查看，當產品需求文檔有修改時，團隊成員仍可通過鏈接查看最新版本。

使用摹客等高效便捷的產品文檔撰寫工具，可以簡化產品文檔撰寫流程，提升產品經理的文檔撰寫能力，讓產品經理事半功倍。

總結

產品需求文檔作為產品開發團隊的重要溝通文檔，文檔的質量好壞會直接影響到各部門是否能夠明確產品的功能和邏輯。一份簡潔易懂、邏輯清晰的產品需求文檔，可以讓團隊溝通更加高效，從而有效提高產品開發團隊的工作效率。

4. 編寫和運行Java程序的步驟是什麼每一步的結果是什麼在JDK中,Java語言的編譯命令是什麼急需答案啊。

步驟：1、編寫java源文件：可用記事本等相關的文本文檔寫源代碼，也可使用java開發集成環境，如：JCreator LE JCreator pro eclipse Myeclipse 等相關的集成開發工具。

2、編譯java源文件生成class文件：手寫的源文件（即不使用開發工具所寫的），在DOS中使用javac 完整的java源文件命來編譯使其生成class文件。注意：寫源文件時，一定要注意存檔。修改源文件也是一樣需要存檔。

3、運行class文件：在dos中輸入所寫的源文件名字（不需要寫後綴名-即.class 嚴格區分大小寫 編譯不需要區分大小寫）。

如使用開發工具所寫：請參照相對應的手冊來點擊開發工具中的按鈕來編譯運行。
java語言的編譯命令就是javac 在dos中輸入javac可見到這個命令的詳細介紹。其他命令也是一樣。至於每一步的結果是什麼，在dos中運行請關注dos運行後的變化。在開發工具中運行請關注開發工具中的改變。不同的程序會產生不同的結果。如：
public class Hello
{
public static void main(String[] args)
{
System.out.println("Hello java");
}
}
這段代碼，在dos中運行後會出現hello java這句話。用開發工具所寫 ，請關注開發工具的界面。

以上內容純屬手打--panzer。希望對你有所幫助。如有疑問：開eml我：[email protected]！

5. Java這個怎麼編

• 為了在您的機器上配置起一個Java開發環境——您將使用一個「開發環境」來「開發」（編寫）程序——您需要完成以下這些步驟：

  1.下載一個包含Java開發環境（編譯器和其他工具）的大文件。點擊「下載J2SE SDK」鏈接下載SDK（軟體開發工具包）軟體。網頁會顯示一個許可協議。點擊「接受」。選擇您的操作系統，然後將文件保存到下載目錄中。這是一個巨大的文件，用電話數據機下載需要好幾個小時。接下來的兩個文件也很大。

  2.下載一個包含Java文檔的大文件。選擇操作系統後點擊SDK1.4.1文檔的鏈接。

  3.如果您的機器上還沒有安裝WinZip（或可執行相同功能的程序），那麼您需要下載一個包含WinZip的大文件並安裝之。如果您的機器上沒有安裝某個的版本的WinZip或其他解壓縮軟體，下載WinZip的試用版。運行EXE文件安裝。很快我們將使用它來安裝文檔。

  4.安裝Java開發環境。運行第一步下載的j2sdk-1_4_1-*.exe文件。他將自動解壓並安裝開發工具包。

  5.安裝文檔。閱讀安裝說明文檔。它會要求您將文檔文件移至剛才開發工具包的安裝目錄。將文檔解壓縮，文件就會被安排到適當的位置。

  6.調整環境變數。按照此頁的要求，您需要改變路徑變數。最簡單的辦法是打開一個MS-DOS窗口鍵入PATH看看當前的路徑變數是什麼，然後用記事本打開autoexec.bat按要求修改PATH環境變數。

  7.全面測試。現在您應該可以打開另一個MS-DOS窗口並鍵入javac了。如果一切設置妥當，那麼您將看到屏幕將輸出兩行文字告訴您如何使用javac。這意味著一切已經准備就緒了。如果您看到「錯誤的命令或文件名」這條消息，則說明還沒有準備好。請重新閱讀安裝說明檢查哪裡出了問題。確定PATH被正確設置並可用。回頭重新閱讀上面的步驟，問題不解決不要輕易放棄。現在您已自豪地擁有一台能夠編譯Java程序的機器了。您已經准備好開始編寫軟體了！

• 順便指出，剛才您解壓縮的內容包括一個demo（演示）目錄，其中包含許多精緻的例子。所有的例子都可以立即執行，所以您不妨找到這個目錄試運行一下其中的某些例子。許多例子都會發聲，所以請打開揚聲器。要運行例子，找到名如example1.html的網頁文件並使用您常用的瀏覽器打開即可。

• 您的第一個程序將是小巧可愛的。它將建立一個繪圖區域並在其上繪制一條對角線。創建此程序您需要：

  1.打開記事本鍵入（或復制粘貼）程序 。建立一個新目錄以保存程序。打開記事本（或其他可以創建TXT文件的文本編輯器）。將范常式序錄入或復制粘貼到記事本窗口中。切記：輸入程序的大小寫敏感。因此必須按照范常式序中字母的大小寫輸入。重審以上編程步驟。如果錄入內容和范常式序不是完全一致，則程序將無法正常運行。

  2.保存程序 。將文件在第一步創建的路徑下保存，文件名為FirstApplet.java。文件名大小寫敏感。請確保字母「F」和「A」大寫，其他字母小寫，如前所示。

  3.使用Java編譯器編譯程序生成一個Java程序 。

  打開一個MS-DOS窗口。改變至包含FirstApplet.java的路徑下（cd），鍵入：
  javac FirstApplet.java

  記住大小寫敏感！或者編譯成功，這時屏幕不輸出任何信息，或者有錯誤發生。若沒有錯誤，則會在目錄里生成一個名為FirstApplet.class的文件與FirstApplet.java並列。

  （請確保程序保存的文件名為FirstApplet.java而不是FirstApplet.java.txt。最簡單的辦法就是在MS-DOS窗口下鍵入dir然後查看文件名。若擴展名是.txt 則請重命名文件去掉此擴展名。也可以運行Windows資源管理器在「查看」菜單下點擊「選項」。確保「隱藏已注冊的MS-DOS文件擴展名」選項處於未選中狀態，然後在資源管理器中查看文件名。若需要則將文件改名。）

  4.排除問題。若有問題產生則想辦法解決。將您的程序與上面的范常式序對比，使之完全相同。修改過程中不斷編譯程序，直到沒有錯誤發生。

  5.建立一個HTML網頁「包含」剛創建的Java程序 。

  創建一個HTML頁面來包含小程序。另開一個記事本窗口。錄入下面的內容：

  將此文件存於同一目錄中，文件名為applet.htm。

  

• 1.運行Java程序 。

  在您的MS-DOS窗口中鍵入：
  appletviewer applet.htm

  應該可以看見一條從左上角到右下角的對角線：（如上圖所示）

  將小程序查看器的窗口拉大一些以查看整條對角線。您也可以將此HTML網頁裝載到任何現用的瀏覽器中，如Netscape Navigator或微軟IE，看到的結果是大致相同的。

  使用Java語言編程就需要一個Java編譯器。下一節將指導您下載並安裝一個編譯器。一旦有了編譯器我們就可以開始學習編程了。下載和安裝過程將會持續幾個小時，大部分時間用來下載幾個很大的文件。您還需要有大約40兆位元組的空閑磁碟空間（開始前請確定有足夠的空間）。

  這里是本節的示範程序：
  import java.awt.Graphics;
  public class FirstApplet extends java.applet.Applet
  {
  public void paint(Graphics g)
  {
  g.drawLine(0, 0, 200, 200);
  }
  }

河南新華

6. 如何用java開發類似word文檔的軟體

在探索基於Web的文檔編輯器的過程中，我發現了canvas-editor這款開源編輯器，其底層基於canvas實現，非常適合開發類似於Word文檔編輯器的軟體。

通過使用canvas-editor，你可以實現與Word類似的效果，並且它提供了豐富的自定義API，讓你可以定製屬於自己的文檔編輯平台。如果你正打算著手開發，那麼canvas-editor將是一個很好的選擇。

該項目由國內的大佬維護，你也可以通過點贊表達支持。

接下來，我將展示使用canvas-editor開發的編輯器效果。

你將看到插入表格、插入公式等操作，這些都與在Word中編寫文檔時的體驗非常相似。

以下是canvas-editor的一些功能點介紹：

使用canvas-editor，你不僅可以享受到豐富的功能，還可以根據自己的需求進行更自由的配置。例如，你可以根據提供的配置實現更高級的編輯功能。

此外，canvas-editor提供了豐富的API，你可以通過查閱文檔來了解更多。

如果你對這款編輯器感興趣，可以訪問其GitHub頁面進行深入研究和使用。