软件文档
- 需求
- 应用场景
- 必要的功能。注意开发的先后顺序,先做主体功能。
- 可选的功能
- 设计方案
- 可能选取的各种方案
- 实现说明
- 架构说明, 解耦, 模块说明
- 网络接口
- 数据库设计说明
- 重要的类,方法
- 测试
软件注释
注释语法 | 备注 |
---|---|
@link | 报名.类名#方法名{@link android.view.Window#requestFeature getWindow().requestFeature()} |
@deprecated | |
@see | 同link |
@throws、@exception | |
@author | |
@time | |
@value | 展示static变量值 |