- 1、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。。
- 2、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
- 4、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
- 5、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
软件工程
第四章 编写程序
软件实现的流程
模块 缺陷跟踪与改错
编程
准 集 软
集
备 代码审查 成 件
成
工 测 系
测
作 单元测试 试 统
试
软件实现阶段的主要成果
计划
软件的源代码和构件库
编程规范、与编程相关的技术文档
测试用例和测试报告等
准备工作
制定计划
• 编程计划、代码审查计划、测试计划
制定编码规范
技术攻关
制定编码规范
文件结构
排版
注释
表达式和语句
标识符命名规则
函数设计规则
类设计规则
内存管理
错误处理
可移植性
命名规范举例(java )
1. 使用全英文确切的表达变量、域、类等。
• 正确的命名方式:firstName, grandTotal ;
• 不合适的命名方式:x1,y5 ;
2. 尽量使用项目或产品相关业务领域的术语,同时要
有统一的词汇表(Glossary )。
3. 命名时使用大小写混合的方式增加可读性,一般情
况第一个字母小写,但是类名、接口名的首字母
大写。
• 正确的命名方式:
• int iSum;
• public class GetPushInformation;
4. 少使用缩写或使用标准的缩写,同时要有统一的缩
略语表(Abbreviation)。
5. 避免使用过长的命名,控制在15个字符以内为宜。
6. 避免相似的命名,同时不使用仅大小写不同的命名。
• 不合适的命名方式
– persistentObject persistentObjects;
– anSqlDatabase AnSQLDatabase;
7. 不在命名的开头或者结尾使用下划线(_ )。
• 不合适的命名方式:
– _iSum, GetPushInformation_ ;
注释
在类、接口、成员函数和域(属性)的声明前使用。
文档编制注释里的内容符合Javadoc标准。
例如:
/**
* Mobile Lottery-A application system developing for
* operator or 3rd party.
* @author Roy Gao
* @param draws,phoneNumber
*/
public class MLottery(int draws,char
phoneNumber){… …}
单行注释
用于成员函数中说明
文档评论(0)