Huilan-Delivery specification

来自cslt Wiki
跳转至: 导航搜索

编程语言:Java

JDK版本:1.6

静态检查工具:findbugs

建议的分词器:AnsJ



1 交付件包括源代码、接口文档、方案文档。


2 源代码使用Java编写,JDK版本使用1.6,原则上不调用非Java的组件或者模块。


3 源代码需要使用findbugs(可集成到Eclipse)进行代码静态检查,对于未消除的错误或者警告需要说明不予修改的原因。


4 提供源代码依赖的所有外部jar包的列表,对于依赖的每个jar包,需要说明引入原因,以及源代码中调用的该jar包的接口列表(主要用于解决将来工程化中的jar包冲突问题)。


5 源代码应注释良好,超过10行的方法在方法头需要有功能说明的注释。


6 接口文档中应提供接口定义、调用方法和示例、以及注意事项。


7 方案文档中应说明实现方案,如参考已公开发表的论文,可提供参考论文列表。