編程風格和文檔記錄要求

編程風格

1、廣泛使用方法

2、使用似有數據字段

3、錯誤處理

4、可讀性

5、文檔記錄

 

 

文檔記錄要求

 

1、程序的初始註釋

a、作用描述

b、作者和日期

c、程序輸入和輸出的描述

d、程序用法描述

e、諸如所需數據類型的假設

f、異常描述、換言之，哪些會出錯

g、簡述主要類

 

2、聲明類的作用，並描述類包含的數據（常量或變量）

 

3、聲明方法的作用、初始條件、結束條件和調用的方法

 

4、方法體註釋，解釋重要功能或微妙的邏輯