欢迎光临散文网 会员登陆 & 注册

2.2 代码注释齐全,系统可维护性就强?

2023-05-17 11:31 作者:xlorne  | 我要投稿



结论

  • 每一行代码都有注释,但是却看不懂代码逻辑

  • 命名规范要比代码注释更重要

    • User类下的save()函数

    • Order类下的cancel()函数

    • 举例:

  • 命名规范必须建立在单一责任(SRP)基础上的,类的职责划分清晰是更重要的事情。

    规范由两大作用,1是使用方便,2是寻找方便

    • 举例:例如我们需要写一个方案,首先感觉自己之前写过,但是却找不到了,那只能重新再写一遍了。

  • 层次的代码注释才是有意义的代码注释

    • 举例:把大象放进冰箱,宏观层次是三步骤,实际过程很复杂。但是需要让从代码宏观层面直接读懂,你的大的步骤是怎么做的,而不是开始就再谈细节过程。

2.2 代码注释齐全,系统可维护性就强?的评论 (共 条)

分享到微博请遵守国家法律