个人博客作业2--代码规范和代码复审

代码规范:

  代码规范作为coders所遵守的一个默认的准则,其存在的意义是十分重要的。

  不以规矩,不能成方圆。如何正确、规范的工作,如何为我们的工作提供依据,并能够高效率的执行,这些都需要正确、行之有效的规范。而代码规范正是保证这一切的基础。它使得不同的人在相互合作的时候能够更加迅速、容易地理解彼此的工作进度与代码信息,为之后的协作提供一个良好的沟通环境。一个人的能力十分有限,所以与他人的沟通协作不可或缺,这更加彰显出代码规范的重要。

  1.这些规范都是官僚制度下产生的浪费大家的编程时间、影响人们开发效率, 浪费时间的东西。

  代码规范的产生并不是出于官僚制度,它的产生是符合代码编写需要的,是必然的产物。其目的是提高代码编写的效率,节约工作时间。或许在一个人单独工作的时候,代码规范会消耗部分的时间,但从团队的角度看来,这一点点的时间消耗换来的整个团队开发时间的降低以及开发效率的大大提升。如果没有这个规范,那么团队成员彼此都需要花费大量的时间去理解对方的代码习惯,对于几十人甚至上百人的团队而言,这种事情简直荒唐可笑,更不可能写出一个好的产品。

  2.我是个艺术家,手艺人,我有自己的规范和原则。

  这句话就更逗了...你明明就是个码代码的,还自称艺术家,难道码代码也算是行为艺术吗...说自己是手艺人倒是勉强可以接受,毕竟是靠手码出的代码。有自己的规范和原则,没问题,自娱自乐足矣。但是如果是和别人一起工作,这种想法还是不要有了。只顾着自己写代码写爽了,却不顾别人痛苦地分析你的代码究竟是什么意思,这么自私的行为就不怕遭到同事们的群殴吗0.0

  3.规范不能强求一律,应该允许很多例外。

  例外当然可以存在,不过如果出现很多例外,那就不行了。对于一个规范而言,有个别的例外很正常,毕竟每个人都有自己的特点,不可能完全一模一样。但如果例外过多,那么规范的权威性就受到了巨大的挑战。每个人都出现很多的例外,那么这个所谓的规范也只不过名存实亡,没有任何用处了。

  4.我擅长制定编码规范,你们听我的就好了。

  我觉得可以让持第四条观点的人和持第二条观点的人去谈一谈,看看这两个中二少年会不会打一架。毕竟这两条观点都实在是太以自我为中心了。在团队的工作中,每个人都是不可或缺的一部分,但这并不是说别人就必须随着自己的意愿。规范的制定应该是根据团队里所有人的状况以及任务需求来决定的,而不是由一个人全权负责。

代码复审:

这是我对我的结对的小伙伴的代码的复审0.0


General


Does the code work? Does it perform its intended function, the logic is correct etc.


程序能正常运行;各个功能都得到了实现,逻辑清晰完整。


Is all the code easily understood?


代码风格很棒,结构清晰,一目了然;有很多注释,代码可读性非常好。


Does it conform to your agreed coding conventions? These will usually cover location of braces, variable and function names, line length, indentations, formatting, and comments.


无论是变量名称的设置,还是代码风格都很好,我应该好好学习学习,我平时真是太随意了0.0


Is there any redundant or duplicate code?


formula_generate 函数包含的功能太多了,划分的更细致一点,可能会简化一部分的功能和代码。


Is the code as modular as possible?


Main函数只有寥寥几行,将其他部分再封装一下应该就实现模块化了。


Can any global variables be replaced?


并不能,不过可以把全局变量改为类变量


Is there any commented out code?


含有被注释掉的代码


Do loops have a set length and correct termination conditions?


循环设置了长度,可正常结束


Can any of the code be replaced with library functions?


没有可以替代的库函数


Can any logging or debugging code be removed?


无日志记录和调试代码


Security


Are all data inputs checked (for the correct type, length, format, and range) and encoded?


输入数据都检查了格式,对于错误的输入格式会进行提示。


Where third-party utilities are used, are returning errors being caught?


未使用第三方程序


Are output values checked and encoded?


输出结果的格式正确


Are invalid parameter values handled?


输入不合法的参数会进行提示,并结束程序


Documentation


Do comments exist and describe the intent of the code?


没有写文档


Are all functions commented?


没有写文档


Is any unusual behavior or edge-case handling described?


没有写文档


Is the use and function of third-party libraries documented?


没有写文档


Are data structures and units of measurement explained?


没有写文档


Is there any incomplete code? If so, should it be removed or flagged with a suitable marker like ‘TODO’?


没有写文档


Testing


Is the code testable? i.e. don’t add too many or hide dependencies, unable to initialize objects, test frameworks can use methods etc.


代码可以测试


Do tests exist and are they comprehensive? i.e. has at least your agreed on code coverage.


没有设计测试代码


Do unit tests actually test that the code is performing the intended functionality?


没有设计测试代码


Are arrays checked for ‘out-of-bound’ errors?


没有进行数组越界检查


Could any test code be replaced with the use of an existing API?


没有设计测试代码

时间: 2024-10-25 23:58:40

个人博客作业2--代码规范和代码复审的相关文章

个人博客作业第二周——是否需要有代码规范

1. 是否需要有代码规范 对于是否需要有代码规范,请考虑下列论点并反驳/支持: 这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西. 我是个艺术家,手艺人,我有自己的规范和原则. 规范不能强求一律,应该允许很多例外. 我擅长制定编码规范,你们听我的就好了. 首先,代码规范是一定要有的,这一点不容置疑.记得刚学C语言时,老师跟我们讲一些编码的例子,譬如说等号两边要加空格,运算符的两边也要加空格.那个时候打心眼里觉得这些规矩太过繁琐迂腐,觉得咱们中国人就是喜欢搞这种形

#个人博客作业week2——结对编程伙伴代码复审

General 1.程序能够顺利地运行.程序通过命令行输入,能够向对应的文件中输出符合要求的题目和答案.程序能够根据用户的不同选择,进行题目的生产或答案的校验,生成出的题目符合参数要求和项目的查重等各种要求,答案校验准确迅速. 2.代码逻辑清晰,没有令人难以理解的部分. 3.他的编码风格与我相似,大括号的使用让我能很清楚地划分模块.变量名很函数名的命名做到了”望文生义“. 4.阅读过程中没有发现冗余重复多余的代码,项目中没有任何一个部分注释掉代码. 5.代码模块化十分清晰,主要分为了表达式,分数

个人博客作业2 - 代码规范讨论与个人项目代码审查

对于是否需要有代码规范,请考虑下列论点并反驳/支持: 这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西. 我是个艺术家,手艺人,我有自己的规范和原则. 规范不能强求一律,应该允许很多例外. 我擅长制定编码规范,你们听我的就好了. 对于论点1,我认为是不正确的.对于一个独立的开发者来说,代码风格可以完全遵从个人意愿,代码规范也没有存在的必要,强调代码规范可能睡些许降低个人的开发效率.但是现代软件工程中,一个开发团队往往少则几个人,多则数百人,一个项目需要多个人同时

C语言博客作业--一二维数组

一.PTA实验作业 题目1:7-2 求整数序列中出现次数最多的数 1. 本题PTA提交列表 2. 设计思路 定义变量n,i,j,max等于0,a[]10用于存放输入的值,b[10]用于存放a[]中各个数有多少个; 输入n的值 i从0开始,每次加1,输入a[i]的值,直到i==n结束循环 i从0开始,判断i是否<n,,进入下一步,每次加一,直到条件不满足 j从0开始,判断j是否<n,,进入下一步,每次加一,直到条件不满足 如果a[i]==a[j],b[i]加一 i从0开始,判断i是否 输出a[j

文件服务相关博客作业

nfs和sameba博客作业 博客实践作业: (1) nfs server导出/data/目录: (2) nfs client挂载/data/至本地的/mydata目录:本地的mysqld或mariadb服务的数据目录设置为/mydata, 要求服务能正常启动,且可正常 存储数据 (3) 客户端(lamp)部署wordpress,并让其正常访问:要确保能正常发文章,上传图片: (4) 客户端2(lamp),挂载nfs server导出的文件系统至/var/www/html:验正其wordpres

https的博客作业

博客作业:分别使用httpd-2.2和httpd-2.4实现 1.建立httpd服务,要求: (1) 提供两个基于名称的虚拟主机www1, www2:有单独的错误日志和访问日志: (2) 通过www1的/server-status提供状态信息,且仅允许tom用户访问: (3) www2不允许192.168.0.0/24网络中任意主机访问: 2.为上面的第2个虚拟主机提供https服务: 前提准备: 172.16.1.1测试httpd-2.4,这是centos7系统 172.16.1.2测试htt

博客作业1--抽象数据类型

一.作业题目 实验题目 试仿照三元组或复数的抽象数据类型写出有理数抽象数据类型的描述 (有理数是其分子.分母均为整数且分母不为零的分数). 有理数基本运算如下所示: 1.构造有理数R,元素x1,x2分别被赋以分子.分母值 2.销毁有理数R 3.用e(引用类型参数)返回有理数T的分子或分母,当入参i为1时返回分子, i为2是返回分母. 4.将有理数R的分子或分母更改为e,入参i为1时改变分子, i为2是改变分母 5.有理数R1,R2相加,结果存入有理数R3 6.有理数R1,R2相减,结果存入有理数

代码备份 | 博客侧边栏公告(支持HTML代码)(支持JS代码)

博客侧边栏公告(支持HTML代码)(支持JS代码) <div id='btnList'> <a class="ivu-btn ivu-btn-primary" href="https://cn.vuejs.org/v2/api/" target="_blank">Vue</a> <a class="ivu-btn ivu-btn-primary" href="https://

代码规范、代码复审、PSP

作业三: 代码规范.代码复审.PSP 代码规范 代码规范的重要性 一.规范的代码可以促进团队合作  一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码必定会风格迥异.且不说会存在多个人同时开发同一模块的情况,即使是分工十分明晰的,等到要整合代码的时候也有够头疼的了.大多数情况下,并非程序中有复杂的算法或是复杂的逻辑,而是去读别人的代码实在是一件痛苦的事情.统一的风格使得代码可读性大大提高了,人们看到任何一段代码都会觉得异常熟悉.显然的,规范的代码在团队的合作开发中是非常有