以太坊java開發文檔
1. 請高手指教,一個java WEB項目的開發文檔要怎麼寫,讓別的程序員一看就明白這個項目的框架是怎麼工作的。
你這個問題問得不太合理,開發文檔要寫很多東西,而你要讓程序員看懂這個項目的話,只要寫交互圖就可以了,至於項目的框架式怎麼工作的,只要告訴程序員是什麼框架就可以了,程序員應該會使用框架
2. 自己寫Java文檔一般需要有哪些內容
每個非 private 方法的參數說明,像 getter/setter 這樣簡單的就省略掉。主要是關鍵方法和類的設計要有說明。另外,一些方法有內部的實現約定,也就是前提條件,這個在技術上沒辦法驗證的或驗證它會影響性能等,我們就只在文檔中說明,不在代碼中檢查了。舉個例子,java.util.ArrayList 不是一個線程安全的集合實現類,它就在文檔中說明了這點,另一個就是 equals 和 hashcode 方法在你覆蓋它時應該同時按相同的演算法覆蓋兩個,只覆蓋一個就不符合設計約定。再一個就是簡要說明你的關鍵方法和類是如何設計的。
一個好的文檔可以用來回答 What, Why & hoW 這三個 W。
3. java api文檔中文版
Java EE 6的是沒有中文的:
http://www.just4e.com/javaee-6/docs/index.html
另外這里能找到絕大多數的Java文檔,給你參考一下:
http://www.just4e.com/
4. java範例開發大全的文檔
http://java.sun.com/j2se/1.5.0/docs/api/index.html
http://gceclub.sun.com.cn/Java_Docs/html/zh_CN/api/index.html
5. 以太坊開發:如何在Windows下開發一個簡易Da
我的電腦->屬性->高級->環境變數->系統變數中添加以下環境變數:
JAVA_HOME值為:安裝JDK的目錄, 我的為C:\Program Files\Java\jdk1.6.0_34
CLASSPATH值為:.;%JAVA_HOME%\lib\tools.jar;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\bin;(注意前面的".;"要加上)
Path: 在開始追加 .;%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin;(注意前面的".;"要加上)
安裝完成之後,可以在檢查JDK是否安裝成功。打開cmd窗口,輸入java –version 查看JDK的版本信息。
6. Java網站功能技術文檔該如何寫
有操作手冊和設計文檔兩種,如果是操作手冊,就從前台,每一步,該從哪裡開始,點擊之後,會出現什麼,下一步如何操作,就是這樣.設計文檔就是根據流程,每一步具體怎麼實現,所用到哪些技術,具體的實現方法是什麼,實現類的路徑.
7. 怎麼用javadoc生成api文檔
javadoc -d myfill -autor -version api.java
myfill是創建的文檔存放位置,名字隨便起,-autor是作者名 -version是版本號 api.java 是java文檔的路徑 如果有包要帶上包名,這里我創建了一個java學習群前面是六六5中間是六一7後邊是150,想學好的可以進來。
8. java中說明書/開發文檔如何編寫
由於在java開發時我們得到的或者給別人的文件一般都是class文件,不會給出源文件,故編寫一個簡潔易懂的說明書是必須的。
ps:@param int[] arr 會有警告,可以刪掉 int []。
用工具解析文檔注釋:javadoc工具
javadoc -d 目錄 -d -author -version ArrayTool.java
有時會提示出錯:找不到可以文檔化的公共或受保護的類-->在class前加一個public即可。
9. 如何書寫Java項目的開發文檔
現在很多文檔的編寫均有自己的固定格式,這方面網路文庫裡面就有不少可以參考的文檔模板。現在以Java方向的文檔為主,簡單結束一下。
1人員流動是項目進行中比較讓人頭疼的事情。做好規範文檔,可以讓代碼看起來比較像出自同一人之手。
2要做java開發文檔得做不少功夫,有需求規格說明書、詳細設計說明書、軟體功能規格說明書、資料庫設計說明書、編碼規范等。比較重要的是 軟體功能描述、資料庫設計、編碼規范,這樣,及時有人員流動的話,新人看了文檔,也能比較快的了解功能需求、資料庫設計、編碼規范,更快的上手項目。
3先看看你需要什麼文檔,然後去文庫里搜索,就有相應的模板,找個適合自己項目的模板用。
10. 做完JAVA項目後,要求寫一份DOC技術文檔說明這個項目,怎麼寫
先寫修訂的人
然後寫這個項目是為了做什麼的
然後用到的技術棧
然後詳細介紹功能 如果是web項目就先介紹各個介面,需要的參數
然後如果時間允許,把幾個重要的表 建模截圖放進去