平时看别人代码也不觉得有多好,但是当自己将代码写完之后,却能清楚的感受到自己写的有多不好。
借此机会在学习一下优秀的代码规范问题:
一、代码风格的重要性
良好的代码风格可以提高代码的可读性和可维护性,降低出错率,提高开发效率。
二、常见的代码风格规范
- 命名规范:使用有意义的变量名、函数名和类名,避免使用缩写和简写。命名应遵循一定的命名规则,如驼峰命名法(camelCase)或下划线命名法(snake_case)。
- 缩进与空格:合理的缩进和空格使用可以使代码结构更加清晰。一般情况下,使用4个空格进行缩进是比较常见的做法。在运算符两侧、逗号后等地方应适当添加空格,提高代码可读性。
- 注释规范:编写注释是提高代码可读性的重要手段。注释应简洁明了,说明代码的功能、目的和实现方式。同时,应避免过多冗余的注释,以免干扰阅读者的视线。
- 代码长度与分行:过长的代码行会降低可读性,因此应将代码行长度控制在一定范围内(如80字符或120字符)。在适当的地方进行分行,使代码结构更加清晰。
- 函数与类的大小:过大的函数或类会增加代码的复杂性,降低可维护性。因此,应将函数和类的功能拆分成较小的部分,使代码更加模块化。
三、方法是方法,能做到才行
- 训练才能改变习惯
- 不要急于求成,改变习惯也需要时间
- 多读优秀的代码,见过好的才能向好的学习
不知何时才有成效,但坚持总会有效果。
四、熵增问题
这不禁让人想起熵增定律来
当系统更有序时,熵较低;当系统更随机和混乱时,熵较高。
熵增定律是指在一个孤立系统中,熵总是趋向于增加。
如果什么都不做,我们自身就是在走向死亡和消散
只有不断强化自己,塑造自己,我们才能活
文档信息
- 本文作者:Chaojie Men
- 本文链接:https://menchaojie.github.io/2024/07/24/code-standard/
- 版权声明:自由转载-非商用-非衍生-保持署名(创意共享3.0许可证)