结对同组同学贾雅杰:http://www.cnblogs.com/jyj5951/
参见教材第68页至第78页,2人结对编写《代码规范》,并在本周作业中遵循。
要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
初始版本(后发生增强的条款用蓝色标明,削弱的用绿色,废除的用红色):
- 为方便维护,必须对每个函数都添加文档注释
- 大括号独占一行并上下对齐(添加规范11)
- 函数采用大驼峰法命名
- 变量采用小驼峰法命名(添加规范12)
- 不要把多个变量定义在一行
- 单个函数不可超过50行
- 关键语句需加注释
- 单行注释在代码上方
- 要清多余导入的包及僵尸代码
- 魔鬼数字必须以变量方式进行调用,不可直接使用
- 为了便于单步调试,需要有断行
- 变量名需要有意义
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。 (20分)
记录如下,博客中对其中不好理解的部分添加了截图解释。
第一条:违反次数2 纠正2次
后来将规范增强为文档注释需要表明用途,形参,返回值等详细信息,如下图所示
第二条:违反次数0次,因为visual studio编辑器会自动格式化生成,将其废除,并改为“为了便于单步调试,需要有断行”该项违反1次,纠正一次如下图
第三条:违反次数6次,纠正六次
第四条:违反0次,故而废除,因为与两人编码习惯皆符合,所以新增条款“变量名需要有意义”
第五条:违反2次,纠正2次
第六条:违反1次,但是因为违规代码已经为精简版本,再减少会影响代码质量,并未纠正,将规则减弱为代码不超过55行(违规代码为52行)违规代码截图
第七条:违反次数7次,纠正2次
第八条:违反4次,纠正4次(每次违反均是因为将注释加在了代码右侧)
第九条:违反17次,纠正2次(这个是在代码完成后统计的,7次是每个多余的包的个数和多余函数的总和,分两次统计,每次统计后一起进行纠正,如下图)
第十条:违反2次,纠正1次
改正:
第十一条:违反4次,纠正一次
第十二条:违反1次,纠正1次
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析
· 没有源码,如何修改代码逻辑?
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· 在鹅厂做java开发是什么体验
· 百万级群聊的设计实践
· WPF到Web的无缝过渡:英雄联盟客户端的OpenSilver迁移实战
· 永远不要相信用户的输入:从 SQL 注入攻防看输入验证的重要性
· 全网最简单!3分钟用满血DeepSeek R1开发一款AI智能客服,零代码轻松接入微信、公众号、小程