程式說明書

程式說明書是對程式流程圖進行注釋的書面檔案,以幫助程式設計人員進一步了解程式的功能和設計要求。它是程式流程圖的配套文檔,也是處理流程設計的配套文檔。程式說明書由系統設計人員編寫,交給程式設計人員使用。因此,程式說明書必須寫得清楚明確,使程式設計人員增加對所要設計的程式的處理過程和設計要求的理解。

程式說明書包括如下七個內容:
1.程式名稱;包括反映程式功能的文字名稱和標識符。
2.程式所屬的系統、子系統或模組的名稱。
3.編寫程式所需使用的語言。
4.輸入的方式和格式:當程式有多種輸入時,分別對每種輸入方式與格式做出具體而細緻
的說明。
5.輸出的方式與格式:當程式有多種內容按不同方式輸出時,分別說明不同內容按不同方
式輸出時的格式。
6.程式處理過程說明:包括程式中使用的計算公式,數學模型和控制方法等。
7.程式運行環境說明:對程式運行所需要的輸入輸出設備的類型和數量,計算機的記憶體及
硬碟容量,支持程式運行的作業系統等內容進行說明。
由於種種原因,在實際工作中不太重視程式說明書的編寫工作。這既不利於程式的設計工作,更不利於對程式的修改和維護工作。因為系統投入運行後,需要經常根據情況的變化進行調整和修改,如果沒有完善的文檔資料,維護、修改就很難進行。

相關詞條

熱門詞條

聯絡我們