开发者社区> 问答> 正文

写代码注释少?git提交备注不规范?:报错

写代码没注释,多难维护啊。。一个业务逻辑看半天才看明白。业务不懂的人就更难明白了。 git提交记录百分之90都是提交代码。。。这,,在git上提交记录的时候谁知道改的是啥啊??大家都用提交代码这个备注就有意思了。。。   养成良好习惯多写注释,自己改了什么代码提交的时候写清楚,这样对自己 对团队都更好吧。 老铁们 怎么看?      

展开
收起
kun坤 2020-06-09 11:26:02 1155 0
1 条回答
写回答
取消 提交回答
  •     的确,提交代码的时候,按照未来读者,用户,软件开发和维护, 以及代码审查的要求,将代码的注释写清楚,这对自己、 对团队都有好处。     比如,软件工程中代码审查一环要求代码唱读者(CI Member: Reader(s)),他/她不允许是代码原作者,也不准是协调员。但他/她要事先做好充分,仔细研究这款软件和代码,以便能够在审查会上,按合适的步调,熟练转述代码。可以想象,合理、充分的代码注释,是帮助代码唱读者的必要资源。     精准完备的代码注释,为以后的软件维护,提供保障。     我就遇到过没有代码注释(或没有完善的注释)的困境:读先人的代码,就好像读"天书"。没法子,只好设法找到原作者,请他给予解释。     与代码规范相伴的,是"代码注释规范"。注释规范的制定,保证提供一系列与代码有关的必要的数据信息。考虑到后人的利益,还是要花费一定的时间,尽量把代码注释写完整、写清晰、写准确。 当然,也有人主张不写代码注释, 并罗列5个理由:诸如,费时、 注释不是测试/验证、 注释没有代码文档可靠、和 代码注释 增添了屏幕空间,要费时间去阅读,等等。     代码注释这个话题,值得一谈。 参考 代码注释规范_ 避免代码注释的五大理由 注释的作用,以及如何写注释  ######老铁 附件几个链接 实在。######这是个好习惯  ######注释多才难维护。代码是持续更新的,注释不一定。代码应该命名良好,结构清晰,可读性强。

    2020-06-09 11:26:07
    赞同 展开评论 打赏
问答排行榜
最热
最新

相关电子书

更多
新一代高效Git协同模型 立即下载
AGit-Flow:新一代高效Git协同模型 立即下载
AGit-flow:新一代高效Git协同模型 立即下载

相关实验场景

更多