编程风格和文档记录要求

编程风格

1、广泛使用方法

2、使用似有数据字段

3、错误处理

4、可读性

5、文档记录

 

 

文档记录要求

 

1、程序的初始注释

a、作用描述

b、作者和日期

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

d、程序用法描述

e、诸如所需数据类型的假设

f、异常描述、换言之，哪些会出错

g、简述主要类

 

2、声明类的作用，并描述类包含的数据（常量或变量）

 

3、声明方法的作用、初始条件、结束条件和调用的方法

 

4、方法体注释，解释重要功能或微妙的逻辑