一个项目的代码注释和架构图重要吗
这个主程离职了,新手要看多久的代码才能接手他的代码?才能去修改他的BUG?或者这个主程,过了半年之后,再去让他讲讲代码逻辑,他需要花多少时间来看代码才能讲得出当初他为什么要这么写,而不是那么写?对于公司的管理者来说,也许你们公司的管理人员都还没有意识到这个问题,维护没有文档的代码,都意味着对开发人员更高的技能要求和工资付出,需要付出更高的学习成本和学习时间,而获得更低的效率。这样的主程,还是不要和他混了
■网友
当然重要啊,尤其是框架类的代码,不写注释没有文档你让谁用啊?你的主程说的那些话只是托辞而已,主程的框架代码写得再好,第一次给我用的时候你让我盯着你写的一个迭代运算看一上午么?没有一个整体结构的概念什么都靠猜,我从程序入口一边调试一边看,你的变量函数命名稍微有点歧义就得耗费我很多时间,更别提再碰到个涉及具体业务的代码,一行注释都没有,那才叫痛苦。一般情况下,代码规范和注释这些东西,如果不是BOSS是做技术的,大多数情况下都是中层技术领导决定的,当然项目负责人也可以决定,所以这就要取决于这些人的素养或者性格了。。作为员工,如果真的无法改变这一现状的话,就硬着头皮上吧,如果真像你主程说的代码写的很优秀,没注释就多调试,累是累了点,也只能这样了
■网友
Windows上开发的话,有地球最强IDE VisualStudio,各种工具一堆,自己查就好。Mac上开发的话Mono/Xamarin中输入\u0026#39;///\u0026#39;可以自动添加注释。如果变量名、函数名足够规范,自动生成的注释基本就够用了。文档自动化可以用Doxygen,根据项目中的注释自动生成各种代码文档。PS:两个人的时候一般来说都是项目比较紧,时间不够的阶段,这种时候时间不够来不及写注释可以忍。但是作为主程来讲,不考虑文档自动化,不考虑将来新人入职的上手成本的问题是不合格的。
推荐阅读
- 同比■同比增长7.1%!2021年的第一个节你花了多少钱?
- “他是我第一个会说普通话的老师”:一对师生折射青海山村蝶变
- 有必要重新开个C店吗
- 大学再有三个月就结束了,没学到知识,参加一个软件测试培训机构好吗
- 汽车|长安UNI-K又将开创一个新的"引力"纪元?
- 神话|武汉传奇父亲:一个平行班孩子创造的高考神话(感动上万家长)
- 王者荣耀李白能不能出肉
- 直播会成为品牌传播的另一个途径么有哪些可行的方法感觉有戏又没头绪好捉急。
- 怎样成为一名合格的Python程序员?
- 知乎有没有必要增加一个特别关注功能
