软件文档、注释规范

软件文档

  • 需求
    • 应用场景
    • 必要的功能。注意开发的先后顺序,先做主体功能。
    • 可选的功能
  • 设计方案
    • 可能选取的各种方案
  • 实现说明
    • 架构说明, 解耦, 模块说明
    • 网络接口
    • 数据库设计说明
    • 重要的类,方法
  • 测试

软件注释

注释语法备注
@link报名.类名#方法名{@link android.view.Window#requestFeature getWindow().requestFeature()}
@deprecated
@see同link
@throws、@exception
@author
@time
@value展示static变量值
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
1标题 软件系统名称和标识符 模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名) 程序编制员签名 卷宗的修改本序号 修改完成日期 卷宗序号(说明本卷宗在整个卷宗中的序号) 编排日期(说明整个卷宗最近的一次编排日期) 2模块开发情况表 3功能说明 扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。 4设计说明 说明本模块(或本组模块)的设计考虑,包括: a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口; b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据卷设计限制、驱动方式和出错信息等; c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑。 5原代码清单 要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。 6测试说明 说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。 7复审的结论 把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值