java文檔怎麼寫

『壹』 java 項目需求文檔要怎麼寫

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

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

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

總結

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

『貳』 java介面文檔怎麼寫

一些剛開始寫介面文檔的服務端同學，很容易按著代碼的思路去編寫介面文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂介面文檔。這篇文章提供一個常規介面文檔的編寫方法，給大家參考。

推薦使用的是docway寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

一、請求參數

1. 請求方法

• GET

用於獲取數據

• POST

用於更新數據，可與PUT互換，語義上PUT支持冪等

• PUT

用於新增數據，可與POST互換，語義上PUT支持冪等

• DELETE

用於刪除數據

• 其他

其他的請求方法在一般的介面中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了介面的請求路徑。路徑中可以包含參數，稱為地址參數，如**/user/{id}**，其中id作為一個參數。

3. HTTP Header

HTTP Header用於此次請求的基礎信息，在介面文檔中以K-V方式展示，其中Content-Type則是一個非常必要的header，它描述的請求體的數據類型。

常用的content-type：

• application/x-www-form-urlencoded

請求參數使用「&」符號連接。

• application/json

內容為json格式

• application/xml

內容為xml格式

• multipart/form-data

內容為多個數據組成，有分隔符隔開

4. HTTP Body

描述http body，依賴於body中具體的數據類型。如果body中的數據是對象類型。則需要描述對象中欄位的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。

示例：



五、介面工具

推薦使用的是http://docway.net（以前叫小幺雞） 寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

『叄』 如何寫Java文檔注釋

如何寫Java文檔注釋(Java Doc Comments)

本文翻譯自How to Write Doc Comments for the Javadoc Tool，但是精簡了一些私以為不重要的東西

本文不討論如何使用javadoc工具自動生成文檔的方法，而是主要探討應該如何去寫文檔注釋

業余時間整理，難免有遺漏或錯誤，如有發現歡迎指正

轉載地址：網頁鏈接

文檔注釋概覽

「文檔注釋」(Java Doc Comments)是專門為了用javadoc工具自動生成文檔而寫的注釋，它是一種帶有特殊功能的注釋。

文檔注釋與一般注釋的最大區別在於起始符號是/**而不是/*或//。

比如：

/**這是文檔注釋*/

/* 這是一般注釋*/

// 這是一般注釋

在一些IDE（比如Eclipse）中，文檔注釋會以不同於普通注釋的顏色高亮顯示。

此外，文檔注釋只負責描述類(class)、介面(interface)、方法(method)、構造器(constructor)、成員欄位(field)。相應地，文檔注釋必須寫在類、介面、方法、構造器、成員欄位前面，而寫在其他位置，比如函數內部，是無效的文檔注釋。

文檔注釋採用HTML語法規則書寫，支持HTML標記(tag)，同時也有一些額外的輔助標記。需要注意的是，這些標記不是給人看的（通常他們的可讀性也不好），他們的作用是為了javadoc工具更好地生成最終文檔。所以，雖然有些標記寫起來麻煩且看著不直觀，還是要老老實實按規矩寫滴。

原文地址：網頁鏈接