java設計文檔

A. 如何書寫java項目的開發文檔

現在很多文檔的編寫均有自己的固定格式，這方面網路文庫裡面就有不少可以參考的文內檔模板。現在以容Java方向的文檔為主，簡單結束一下。

1人員流動是項目進行中比較讓人頭疼的事情。做好規範文檔，可以讓代碼看起來比較像出自同一人之手。
2要做java開發文檔得做不少功夫，有需求規格說明書、詳細設計說明書、軟體功能規格說明書、資料庫設計說明書、編碼規范等。比較重要的是 軟體功能描述、資料庫設計、編碼規范，這樣，及時有人員流動的話，新人看了文檔，也能比較快的了解功能需求、資料庫設計、編碼規范，更快的上手項目。
3先看看你需要什麼文檔，然後去文庫里搜索，就有相應的模板，找個適合自己項目的模板用。

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

需求文檔一般分兩類
需求調研報告
需求分析報告

調研報告：是記錄的版用戶的原始需求，基本上權可以算做是和用戶溝通的原始記錄。
分析報告：是對調研報告進行歸類分析的結果。一個比較全面的文檔了，在這個文檔裡面一般包含以下內容：
項目的背景
項目的目標
項目的范圍
用戶特點
相關技術、規范標准等
相關約束
用戶的組織結構、角色等
用戶需要的功能點，這些功能的優先順序，業務流程、功能特點，有沒有特殊需求等等

總而言之，需求分析報告的下一站是給設計人員的，設計人員看到需求分析報告就知道系統應該包含哪些功能點、許可權設計、流程設計等，這些內容都可以直接從需要分析報告裡面得出

C. Java web設計文檔怎麼寫

自己網路「宿舍管理系統」設計方案（詳細設計，設計文檔）類似的關鍵字看回看，這個和JAVA WEB沒啥具體關答系，javaweb只是它的表現形式。
你參考網上的文檔，按照模版把項目基本內容填一下，功能方面：你要的功能也就無非是"入住"「搬出」「查看」「列印」四大功能而已，對這四大功能詳細說明一下（對每個功能採用語言+圖例的形式就更好了）就算是一個簡單的設計文檔了
https://wenku..com/view/15797606de80d4d8d15a4f2b.html這個我看挺合適你要的。

D. java開發文檔怎麼寫

問了一下我在遠標教育的哥們，他說要做java開發文檔得做不少功夫，有需求規格說明書、詳細設計說明書、軟體功能規格說明書、資料庫設計說明書、編碼規范等。比較重要的是 軟體功能描述、資料庫設計、編碼規范，這樣，及時有人員流動的話，新人看了文檔，也能比較快的了解功能需求、資料庫設計、編碼規范，更快的上手項目。

E. JAVA語言程序設計中如何進行文檔注釋

//單行注釋 /* */多行注釋 快捷鍵是：ctrl+反斜線 取消注釋是：ctrl+斜線 同時右鍵可以看到添加塊注釋

F. 求java編寫的倉庫管理系統源代碼或詳細設計

import java.util.*;
import java.awt.event.*;
import java.awt.*;
import javax.swing.*;
import java.io.*;
class 商品 extends Panel
{String 代號,名稱;int 庫存;float 單價;
商品(String 代號,String 名稱,int 庫存,float 單價)
{this.代號=代號;this.名稱=名稱;this.庫存=庫存;this.單價=單價;
}
}
class ShowWin extends JFrame implements ActionListener
{ Hashtable hashtable=null;
JTextField 代號文本框=new JTextField(),
名稱文本框=new JTextField(),
庫存文本框=new JTextField(),
單價文本框=new JTextField(),
查詢文本框=new JTextField(),
查詢信息文本框=new JTextField(),
刪除文本框=new JTextField();
JButton b_add=new JButton("添加商品"),
b_del=new JButton("刪除商品"),
b_xun=new JButton("查詢商品"),
b_xiu=new JButton("修改商品"),
b_show=new JButton("顯示商品清單");
JTextArea 顯示區=new JTextArea(25,10);
ShowWin()
{super("倉庫管理窗口");
hashtable=new Hashtable();
Container con=getContentPane();
JScrollPane pane=new JScrollPane(顯示區);
顯示區.setEditable(false);
JPanel save=new JPanel();
save.setLayout(new GridLayout(8,2));
save.add(new Label("輸入代號:"));
save.add(代號文本框);
save.add(new Label("輸入名稱:"));
save.add(名稱文本框);
save.add(new Label("輸入庫存:"));
save.add(庫存文本框);
save.add(new Label("輸入單價:"));
save.add(單價文本框);
save.add(new Label("單擊添加:"));
save.add(b_add);
save.add(new Label("單擊修改:"));
save.add(b_xiu);
save.add(new Label("輸入查詢代號:"));
save.add(查詢文本框);
save.add(new Label("單擊查詢:"));
save.add(b_xun);
JPanel del=new JPanel();
del.setLayout(new GridLayout(2,2));
del.add(new Label("輸入刪除的代號:"));
del.add(刪除文本框);
del.add(new Label("單擊刪除:"));
del.add(b_del);
JPanel show=new JPanel();
show.setLayout(new BorderLayout());
show.add(pane,BorderLayout.CENTER);
show.add(b_show,BorderLayout.SOUTH);
JSplitPane split_one,split_two;
split_one=new JSplitPane(JSplitPane.VERTICAL_SPLIT,save,del);
split_two=new
JSplitPane(JSplitPane.HORIZONTAL_SPLIT,true,split_one,show);
con.add(split_two,BorderLayout.CENTER);
JPanel xun=new JPanel();
xun.add(new Label("所得信息:"));
xun.add(查詢信息文本框);
xun.setLayout(new GridLayout(2,1));
con.add(xun,BorderLayout.SOUTH);
b_add.addActionListener(this);
b_del.addActionListener(this);
b_xun.addActionListener(this);
b_xiu.addActionListener(this);
b_show.addActionListener(this);
}
public void actionPerformed(ActionEvent e)
{if(e.getSource()==b_add)
{String daihao=null,mingcheng=null;int kucun=0;float danjia=0.0f;
daihao=代號文本框.getText();mingcheng=名稱文本框.getText();
kucun=Integer.parseInt(庫存文本框.getText());
danjia=Float.valueOf(單價文本框.getText()).floatValue();
商品 goods=new 商品(daihao,mingcheng,kucun,danjia);
hashtable.put(daihao,goods);
try{FileOutputStream file=new FileOutputStream("goods.txt");
ObjectOutputStream out=new ObjectOutputStream(file);
out.writeObject(hashtable); out.close();
}
catch(IOException event){}
}
else if(e.getSource()==b_del)
{String daihao1=刪除文本框.getText();
try{FileInputStream come_in=new FileInputStream("goods.txt");
ObjectInputStream in=new ObjectInputStream(come_in);
hashtable=(Hashtable)in.readObject(); //////
in.close();
}
catch(ClassNotFoundException event){}
catch(IOException event){}
商品 temp=(商品)hashtable.get(daihao1);
{hashtable.remove(daihao1);}
try{FileOutputStream file=new FileOutputStream("goods.txt");
ObjectOutputStream out =new ObjectOutputStream(file);
out.writeObject(hashtable);//
out.close();
}
catch(IOException event){}
}
//
else if(e.getSource()==b_xun)
{ String aa;
aa=查詢文本框.getText();
查詢信息文本框.setText(null);
try{FileInputStream come_in=new FileInputStream("goods.txt");
ObjectInputStream in =new ObjectInputStream(come_in);
hashtable=(Hashtable)in.readObject(); ////
in.close();
}
catch(ClassNotFoundException event){}
catch(IOException event){}
商品 a=(商品)hashtable.get(aa);
查詢信息文本框.setText(" 代號："+a.代號+" 名稱："+a.名稱+" 庫存："+a.庫存+" 單價："+a.單價);
}
//
else if(e.getSource()==b_xiu)
{ String bb;
bb=代號文本框.getText();
try{FileInputStream come_in=new FileInputStream("goods.txt");
ObjectInputStream in=new ObjectInputStream(come_in);
hashtable=(Hashtable)in.readObject(); //////
in.close();
}
catch(ClassNotFoundException event){}
catch(IOException event){}
商品 temp=(商品)hashtable.get(bb);
{hashtable.remove(bb);}
try{FileOutputStream file=new FileOutputStream("goods.txt");
ObjectOutputStream out =new ObjectOutputStream(file);
out.writeObject(hashtable);//
out.close();
}
catch(IOException event){}
String daihao1=null,mingcheng1=null;int kucun1=0;float danjia1=0.0f;
daihao1=代號文本框.getText();mingcheng1=名稱文本框.getText();
kucun1=Integer.parseInt(庫存文本框.getText());
danjia1=Float.valueOf(單價文本框.getText()).floatValue();
商品 goods1=new 商品(daihao1,mingcheng1,kucun1,danjia1);
hashtable.put(daihao1,goods1);
try{FileOutputStream file=new FileOutputStream("goods.txt");
ObjectOutputStream out=new ObjectOutputStream(file);
out.writeObject(hashtable); out.close();
}
catch(IOException event){}

}
//
else if(e.getSource()==b_show)
{ 顯示區.setText(null);
try{FileInputStream come_in=new FileInputStream("goods.txt");
ObjectInputStream in =new ObjectInputStream(come_in);
hashtable=(Hashtable)in.readObject(); ////
}
catch(ClassNotFoundException event){}
catch(IOException event){}
Enumeration enum=hashtable.elements();
while(enum.hasMoreElements())
{ 商品 te=(商品)enum.nextElement();
顯示區.append("商品代號:"+te.代號+" ");
顯示區.append("商品名稱:"+te.名稱+" ");
顯示區.append("商品庫存:"+te.庫存+" ");
顯示區.append("商品單價:"+te.單價+" ");
顯示區.append("\n ");
}
}
}
}
public class LinkListFour
{public static void main(String args[])
{ ShowWin win=new ShowWin();
win.setSize(400,350);
win.setVisible(true);
win.addWindowListener(new WindowAdapter()
{public void windowClosing(WindowEvent e)
{ System.exit(0);}});
}
}

G. 怎麼用java調用用codesoft設計的條形碼文檔

現在代碼共享如下，僅供參考因為本人還不精通。
package
com.prodPrint;
import
java.io.File;
import
java.util.HashMap;
import
org.eclipse.swt.SWT;
import
org.eclipse.swt.ole.win32.OleAutomation;
import
org.eclipse.swt.ole.win32.OleControlSite;
import
org.eclipse.swt.ole.win32.OleFrame;
import
org.eclipse.swt.ole.win32.Variant;
import
org.eclipse.swt.widgets.Composite;
import
org.eclipse.swt.widgets.Display;
import
org.eclipse.swt.widgets.Shell;
import
com.lppx2.OleDispatch;
public
class
ActiveXPrinter
extends
Composite{
private
OleFrame
myFrame
=
new
OleFrame(this,
SWT.NONE);
//
Microsoft
Internet
Explorer
ProgID:
Shell.Explorer.2
//
Codesoft
ProgID
:
Lppx2.Application
private
String
progId
=
"Lppx2.Application";
private
OleControlSite
controlSite;
private
OleAutomation
automation;;
private
OleDispatch
appActiveDoc;
private
OleDispatch
appDocs;
File
currentFile;
public
ActiveXPrinter(Composite
parent,
int
style)
{
super(parent,
style);
myFrame
=
new
OleFrame(this,
SWT.NONE);
controlSite
=
new
OleControlSite(myFrame,
SWT.NONE,
progId);
automation
=
new
OleAutomation(controlSite);
}
public
void
print
(String
fileName)
{
currentFile
=
new
File(fileName);
initialize();
}
private
void
initialize()
{
try{
Variant
documents
=
(new
OleDispatch(automation)).Invoke("Documents",new
Variant[0]);
appDocs
=
new
OleDispatch(documents.getAutomation());
if
(!currentFile.canRead()
)
{
System.out.println("Unable
to
read
file
:
"
+
currentFile);
}
else
{
Variant
file[]
=
new
Variant[1];
file[0]
=
new
Variant(currentFile.getAbsolutePath());
if
(appDocs.Invoke("Open",
file)
!=
null)
{
System.out.println(currentFile.getAbsolutePath()
+
"
is
opened
now");
}
else
{
System.out.println("Unable
to
open
"
+
currentFile.getAbsolutePath());
}
Variant
activeDocumentV
=
(new
OleDispatch(automation)).Invoke(
"ActiveDocument",
new
Variant[0]);
try
{
appActiveDoc
=
new
OleDispatch(activeDocumentV.getAutomation());
}
catch
(Exception
excpt)
{
}
Variant[]
quantity
=
new
Variant[1];
quantity[0]
=
new
Variant(1);
if
(appActiveDoc.Invoke("PrintDocument",
quantity)
!=
null)
System.out.println("Print
OK");
else
{
System.out.println("Unable
to
print
!");
}
}
}catch(Exception
excpt)
{
System.out.println("You
can't
print
anything
until
a
document
is
opened
!");
excpt.printStackTrace();
return;
}
}
public
static
void
main(String[]
args)
{
Display
display
=
Display.getDefault();
Shell
shell
=
new
Shell(display);
new
ActiveXPrinter(shell,
0).print("C:\Document1.Lab");
while
(!shell.isDisposed())
{
if
(!display.readAndDispatch())
{
display.sleep();
}
}
display.dispose();
}
}

H. java軟體工程師的工作描述怎麼寫

一、籠統的描述自己的工作內容

1、負責研發公司應用軟體的模塊設計、開發和交付

2、負責編碼，單元測試

3、按照功能組件的詳細設計

4、對其他軟體工程師的代碼進行審核

5、參與新知識的學習和培訓

6、修復程序BUG

7、參與與其業務相關的需求變更評審

8、完成上級交辦的其他事宜

9、編寫技術設計文檔

二、以項目的形式體現自己的工作內容和技術能力

比較推薦這一種方式，內容中主要包括：項目開始時間，完成時間，使用了哪些技術，完成了什麼功能?多少人的團隊，你在其中起什麼作用等。如

項目名稱：《企業管理信息系統》 時期：XXXX/XX-XX

項目描述：以B/S方式實現管理網站的功能：企業員工通過企業分配的個人帳戶可以搜索企業信息，查詢企業所布置的任務;企業管理者可以通過注冊系統帳戶來搜索和布置任務，而且能對企業的員工進行許可權限制等信息和功能。

使用技術：JAVA，C，Oracle，Shell

開發工具：Eclipse

責任描述：系統維護和編碼工作(5人小組，擔任組長)

項目總結：遇到的問題及解決方法。

I. Java企業軟體開發設計說明書如何做

1、組織與風格(1).關鍵詞和操作符之間加適當的空格。(2).相對獨立的程序塊與塊之間加空行(3).較長的語句、表達式等要分成多行書寫。(4).劃分出的新行要進行適應的縮進，使排版整齊，語句可讀。(5).長表達式要在低優先順序操作符處劃分新行，操作符放在新行之首。(6).循環、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分。(7).若函數或過程中的參數較長，則要進行適當的劃分。(8).不允許把多個短語句寫在一行中，即一行只寫一條語句。(9).函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要採用縮進風格。註：如果大家有興趣可以到安安DIY創作室博客，有相關說明性的文章和解釋。2、註解Java 的語法與 C++ 及為相似，那麼，你知道 Java 的注釋有幾種嗎？是兩種？// 注釋一行/* ...... */ 注釋若干行不完全對，除了以上兩種之外，還有第三種，文檔注釋：/** ...... */ 注釋若干行，並寫入 javadoc 文檔注釋要簡單明了。String userName = null; //用戶名邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。在必要的地方注釋，注釋量要適中。注釋的內容要清楚、明了，含義准確，防止注釋二義性。保持注釋與其描述的代碼相鄰，即注釋的就近原則。對代碼的注釋應放在其上方相鄰位置，不可放在下面。對數據結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋應放在此域的右方；同一結構中不同域的注釋要對齊。變數、常量的注釋應放在其上方相鄰位置或右方。全局變數要有較詳細的注釋，包括對其功能、取值范圍、哪些函數或過程存取它以及存取時注意事項等的說明。在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者；生成日期；模塊功能描述（如功能、主要演算法、內部各部分之間的關系、該文件與其它文件關系等）；主要函數或過程清單及本文件歷史修改記錄等。/*** Copy Right Information : Neusoft IIT* Project : eTrain* JDK version used : jdk1.3.1* Comments : config path* Version : 1.01* Modification history :2003.5.1* Sr Date Modified By Why & What is modified* 1. 2003.5.2 Kevin Gao new**/在每個函數或過程的前面要有必要的注釋信息，包括：函數或過程名稱；功能描述；輸入、輸出及返回值說明；調用關系及被調用關系說明等/*** Description :checkout 提款* @param Hashtable cart info* @param OrderBean order info* @return String*/public String checkout(Hashtable htCart,OrderBean orderBean)throws Exception{}javadoc注釋標簽語法@author 對類的說明 標明開發該類模塊的作者@version 對類的說明 標明該類模塊的版本@see 對類、屬性、方法的說明 參考轉向，也就是相關主題@param 對方法的說明 對方法中某參數的說明@return 對方法的說明 對方法返回值的說明@exception 對方法的說明 對方法可能拋出的異常進行說明3、命名規范定義這個規范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規范並不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過去掉母音形成縮寫；要不然最後自己寫的代碼自己都看不懂了，那可不行。較長的單詞可取單詞的頭幾發符的優先順序，並用括弧明確表達式的操作順序，避免使用默認優先順序。使用匈牙利表示法Package 的命名Package 的名字應該都是由一個小寫單片語成。package com.neu.utilClass 的命名Class 的名字必須由大寫字母開頭而其他字母都小寫的單片語成,對於所有標識符，其中包含的所有單詞都應緊靠在一起，而且大寫中間單詞的首字母。public class ThisAClassName{}Class 變數的命名變數的名字必須用一個小寫字母開頭。後面的單詞用大寫字母開頭userName , thisAClassMethodStatic Final 變數的命名static Final 變數的名字應該都大寫，並且指出完整含義。/***DBConfig PATH**/public static final StringDB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;參數的命名參數的名字必須和變數的命名規范一致。數組的命名數組應該總是用下面的方式來命名：byte[] buffer;而不是：byte buffer[];方法的參數使用有意義的參數命名，如果可能的話，使用和要賦值的欄位一樣的名字：SetCounter(int size){this.size = size;}4、文件樣式所有的 Java(*.java) 文件都必須遵守如下的樣式規則：版權信息版權信息必須在 java 文件的開頭，比如：/** Copyright ? 2000 Shanghai XXX Co. Ltd.* All right reserved.*/其他不需要出現在 javadoc 的信息也可以包含在這里。Package/Importspackage 行要在 import 行之前，import 中標準的包名要在本地的包名之前，而且按照字母順序排列。如果 import 行中包含了同一個包中的不同子目錄，則應該用 * 來處理。package hotlava.net.stats;import java io.*;import java.util.Observable;import hotlava.util.Application;這里 java。io.* 使用來代替InputStream and OutputStream 的。Class接下來的是類的注釋，一般是用來解釋類的。/*** A class representing a set of packet and byte counters* It is observable to allow it to be watched, but only* reports changes when the current set is complete*/接下來是類定義，包含了在不同的行的 extends 和 implementspublic class CounterSetextends Observableimplements CloneableClass Fields接下來是類的成員變數：/*** Packet counters*/protected int[] packets;public 的成員變數必須生成文檔（JavaDoc）。proceted、private和 package 定義的成員變數如果名字含義明確的話，可以沒有注釋。存取方法接下來是類變數的存取的方法。它只是簡單的用來將類的變數賦值獲取值的話，可以簡單的寫在一行上。/*** Get the counters* @return an array containing the statistical data. This array has been* freshly allocated and can be modified by the caller.*/public int[] getPackets() { return Array(packets, offset); }public int[] getBytes() { return Array(bytes, offset); }public int[] getPackets() { return packets; }public void setPackets(int[] packets) { this.packets = packets; }其它的方法不要寫在一行上構造函數接下來是構造函數，它應該用遞增的方式寫（比如：參數多的寫在後面）。訪問類型 (public, private 等.) 和 任何 static, final 或 synchronized 應該在一行中，並且方法和參數另寫一行，這樣可以使方法和參數更易讀。publicCounterSet(int size){this.size = size;}克隆方法如果這個類是可以被克隆的，那麼下一步就是 clone 方法：publicObject clone() {try {CounterSet obj = (CounterSet)super.clone();obj.packets = (int[])packets.clone();obj.size = size;return obj;}catch(CloneNotSupportedException e) {throw new InternalError(Unexpected CloneNotSUpportedException: +e.getMessage());}}類方法下面開始寫類的方法：/*** Set the packet counters* (such as when restoring from a database)*/protected finalvoid setArray(int[] r1, int[] r2, int[] r3, int[] r4)throws IllegalArgumentException{//// Ensure the arrays are of equal size//if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)throw new IllegalArgumentException(Arrays must be of the same size);System.array(r1, 0, r3, 0, r1.length);System.array(r2, 0, r4, 0, r1.length);}toString 方法無論如何，每一個類都應該定義 toString 方法：publicString toString() {String retval = CounterSet: ;for (int i = 0; i < data.length(); i++) {retval += data.bytes.toString();retval += data.packets.toString();}return retval;}}main 方法如果main(String[]) 方法已經定義了, 那麼它應該寫在類的底部.5、代碼可讀性避免使用不易理解的數字，用有意義的標識來替代。不要使用難懂的技巧性很高的語句。源程序中關系較為緊密的代碼應盡可能相鄰。6、代碼性能在寫代碼的時候，從頭至尾都應該考慮性能問題。這不是說時間都應該浪費在優化代碼上，而是我們時刻應該提醒自己要注意代碼的效率。比如：如果沒有時間來實現一個高效的演算法，那麼我們應該在文檔中記錄下來，以便在以後有空的時候再來實現她。不是所有的人都同意在寫代碼的時候應該優化性能這個觀點的，他們認為性能優化的問題應該在項目的後期再去考慮，也就是在程序的輪廓已經實現了以後。不必要的對象構造不要在循環中構造和釋放對象使用 StringBuffer 對象在處理 String 的時候要盡量使用 StringBuffer 類，StringBuffer 類是構成 String 類的基礎。String 類將 StringBuffer 類封裝了起來，（以花費更多時間為代價）為開發人員提供了一個安全的介面。當我們在構造字元串的時候，我們應該用 StringBuffer 來實現大部分的工作，當工作完成後將 StringBuffer 對象再轉換為需要的 String 對象。比如：如果有一個字元串必須不斷地在其後添加許多字元來完成構造，那麼我們應該使用StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替StringBuffer 對象的話，會花費許多不必要的創建和釋放對象的 CPU 時間。大家可以來安安DIY創作室一起討論。避免太多的使用 synchronized 關鍵字避免不必要的使用關鍵字 synchronized，應該在必要的時候再使用她，這是一個避免死鎖的好方法。7、編程技巧byte 數組轉換到 characters為了將 byte 數組轉換到 characters，你可以這么做：Hello world!.getBytes();Utility 類Utility 類（僅僅提供方法的類）應該被申明為抽象的來防止被繼承或被初始化。初始化下面的代碼是一種很好的初始化數組的方法：objectArguments = new Object[] { arguments };枚舉類型JAVA 對枚舉的支持不好，但是下面的代碼是一種很有用的模板：class Colour {public static final Colour BLACK = new Colour(0, 0, 0);public static final Colour RED = new Colour(0xFF, 0, 0);public static final Colour GREEN = new Colour(0, 0xFF, 0);public static final Colour BLUE = new Colour(0, 0, 0xFF);public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);}這種技術實現了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。他們可以用 '==' 操作符來比較。但是這樣使用有一個缺陷：如果一個用戶用這樣的方法來創建顏色 BLACK new Colour(0,0,0)那麼這就是另外一個對象，'=='操作符就會產生錯誤。她的 equal() 方法仍然有效。由於這個原因，這個技術的缺陷最好註明在文檔中，或者只在自己的包中使用。8、編寫格式代碼樣式代碼應該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）文檔化必須用 javadoc 來為類生成文檔。不僅因為它是標准，這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的，因為代碼不應該是被個人擁有的。縮進縮進應該是每行2個空格. 不要在源文件中保存Tab字元. 在使用不同的源代碼管理工具時Tab字元將因為用戶設置的不同而擴展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過如下操作來禁止保存Tab字元, 方法是通過 UltrEdit中先設定 Tab 使用的長度室2個空格，然後用 Format|Tabs to Spaces 菜單將 Tab 轉換為空格。頁寬頁寬應該設置為80字元. 源代碼一般不會超過這個寬度, 並導致無法完整顯示, 但這一設置也可以靈活調整. 在任何情況下, 超長的語句應該在一個逗號或者一個操作符後折行. 一條語句折行後, 應該比原來的語句再縮進2個字元.{} 對{} 中的語句應該單獨作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:if (i>0) { i ++ }; // 錯誤, { 和 } 在同一行if (i>0) {i ++}; // 正確, { 單獨作為一行} 語句永遠單獨作為一行.如果 } 語句應該縮進到與其相對應的 { 那一行相對齊的位置。括弧左括弧和後一個字元之間不應該出現空格, 同樣, 右括弧和前一個字元之間也不應該出現空格. 下面的例子說明括弧和空格的錯誤及正確使用:CallProc( AParameter ); // 錯誤CallProc(AParameter); // 正確不要在語句中使用無意義的括弧. 括弧只應該為達到某種目的而出現在源代碼中。下面的例子說明錯誤和正確的用法:if ((I) = 42) { // 錯誤 - 括弧毫無意義if (I == 42) or (J == 42) then // 正確 - 的確需要括弧9、代碼編譯1.編寫代碼時要注意隨時保存，並定期備份，防止由於斷電、硬碟損壞等原因造成代碼丟失。2.同一項目組內，最好使用相同的編輯器，並使用相同的設置選項。3.合理地設計軟體系統目錄，方便開發人員使用。4.打開編譯器的所有告警開關對程序進行編譯。5.在同一項目組或產品組中，要統一編譯開關選項。6.使用工具軟體（如Visual SourceSafe）對代碼版本進行維護。如果大家有不明白的可以到安安DIY創作室留言。10、可移植性Borland Jbulider 不喜歡 synchronized 這個關鍵字，如果你的斷點設在這些關鍵字的作用域內的話，調試的時候你會發現的斷點會到處亂跳，讓你不知所措。除非必須，盡量不要使用。換行如果需要換行的話，盡量用 println 來代替在字元串中使用\n。你不要這樣：System.out.print(Hello,world!\n);要這樣：System.out.println(Hello,world!);或者你構造一個帶換行符的字元串，至少要象這樣：String newline = System.getProperty(line.separator);System.out.println(Hello world + newline);PrintStreamPrintStream 已經被不贊成（deprecated）使用，用 PrintWrite 來代替它。

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

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

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