1 針對性
文檔編制以前應分清讀者對象,按不同的類型、不同層次的讀者,決定怎樣適應他們的需要。
① 對于面向管理人員和用戶的文檔,不應像開發文檔(面向軟件開發人員)那樣過多地使用軟件的專業術語。 難以避免使用的詞匯,應在文檔中添加詞匯表,進行解釋。
② 開發文檔使用的專業詞匯未被廣泛認知的,應添加注釋進行說明。
③ 縮寫詞未被廣泛認知的,應在其后跟上完整的拼寫。
2 正確性
① 沒有錯字,漏字。
② 文檔間引用關系正確。
③ 文檔細節(Title/History)正確。
3 準確性
① 意思表達準確清晰,沒有二義性。
② 正確使用標點符號,避免產生歧義。
4 完整性
① 意思表達完整,能找到主語、謂語、賓語,沒有省略主語,特別是謂語。
② 一句話中不能出現幾個動詞一個賓語的現象。
③ 不遺漏要求和必需的信息。
5 簡潔性
① 盡量不要采用較長的句子來描述,無法避免時,應注意使用正確的標點符號。
② 簡潔明了,不累贅冗余,每個意思只在文檔中表達一次。
③ 每個陳述語句,只表達一個意思。
④ 力求簡明,如有可能,配以適當的圖表,以增強其清晰性。
6 統一性
① 統一采用專業術語和項目規定的術語集。
② 同一個意思和名稱,前后描述的用語要一致。
③ 文檔前后使用的字體要統一。
④ 同一課題若干文檔內容應該協調一致,沒有矛盾。
7 易讀性
① 文字描述要通俗易懂。
② 前后文關聯詞使用恰當。
③ 文檔變更內容用其他顏色與上個版本區別開來。
④ 測試步驟要采用列表的方式,用1)、2)、3)…等數字序號標注。
以下配置環境是SQL Server 2000、Tomcat5.0.28
1、把msbase.jar、sqlserver.jar、msutil.jar三個文件拷貝到%TOMMCAT_HOME%\common\lib 目錄下
2、在webapp下新建一個文檔,再在%TOMCAT_HOME%\conf\Catalina\localhost\ 新建一個與webapp下文檔名相同的.xml
3、把一下文件拷貝到上面新建的.xml中(注:也可以把以下內容拷貝到%TOMCAT_HOME%\conf、servlet.xml中,第2步新建.xml就可以省略[不過有個弊端參閱:5])
<?xml version="1.0" encoding="GB2312"?>
<Context path="/(webapp下新建的文檔)">
<Logger className="org.apache.catalina.logger.FileLogger"prefix="localhost_admin_log." suffix=".txt" timestamp="true"/>
<Resource type="javax.sql.DataSource" auth="Container" name="(數據源名字)"/>
<ResourceParams name="(數據源名字)"/>
<parameter>
<name>maxWait</name> //最大等待時間
<value>5000</value>
</parameter>
<parameter>
<name>maxActive</name>//最大連接數:達到這個數字時候 就不要在連接
<value>4</value>
</parameter>
<parameter>
<name>maxIdle</name> ///最大的維持數:如果沒有用戶連接時候 連接池中保持 這么多個連接
<value>2</value>
</parameter>
<parameter>
<name>username</name>
<value>sa</value>
</parameter>
<parameter>
<name>password</name>
<value></value>
</parameter>
<parameter>
<name>url</name>
<value>jdbc:microsoft:sqlserver://localhost:1433;databaseName=(數據庫名)</value>
</parameter>
<parameter>
<name>driverClassName</name>
<value>com.microsoft.jdbc.sqlserver.SQLServerDriver</value>
</parameter>
</ResourceParams>
</Context>
4、如果你在Eclipse或JBuilder 中開發的話,你需要在你的Web應用程序的WEB- INF\Web.xml文件中注冊數據源,文件添加如下內容:
<resource-ref>
<res-ref-name>jdbc/northwind</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
</resource-ref>
5、忠告在做任何配置時最好不要修改Tomcat服務器的任何文件,如servel.xml或web.xml文件,而所有的操作和配置都可以在你自己的應用配置文件中來完成,這樣即使培植錯誤也不至于服務器的崩潰。
6、撰寫測試文檔
<%@ page import="java.sql.*"%>
<%@ page import="javax.sql.*"%>
<%@ page import="javax.naming.*"%>
<%!
final String JNDINAME="java:comp/env/(數據源名字)"
%>
<%
Connection conn =null;
try
{
//初始化查找命名空間
Context ctx = new InitialContext();
//找到DataSourse
DataSource ds = (DataSourse)ctx.lookup(數據庫名);
conn = ds.getConnection();
}
catch(Exception e){
System.out.println(e);
}
%>
備注:在Tomcat 5.5.xx中使用以前的配置方式,會出現以下問題:“Cannot create JDBC driver of class '' for connect URL 'null'”。
解決方法是,把如下格式的Resource描述插入server.xml 的<Context></Context>中:
<Resource name="jdbc/db" type="javax.sql.DataSource" username="sa" password=""
driverClassName="com.microsoft.jdbc.sqlserver.SQLServerDriver"
maxIdle="2"maxWait="5000" url="jdbc:microsoft:sqlserver://localhost:1433;DatabaseName=jspdev" maxActive="4"/>
用以取代以上的配置方式。
在Tomcat中配置數據源很復雜 但在weblogic和websphere中 會給出特定的界面 給你配置 比較方便