代码规范性概述对于程序员而言写代码在多个场合都会遇到。写代码的时候代码规范性是一个值得关注的问题。代码规范性可以列举出很多点部分常见的规范标准如下。命名规范。无论是变量、函数/方法还是类/模块都应遵循各自的大小写规则并且命名应该有充分的描述性。代码格式规范。使用一致的缩进方式单行代码的长度不宜过长。代码结构规范。每个函数/方法或类的职责应该单一避免同时具有多个职责。函数/方法应保持简短避免过长。应避免嵌套层数过多的情况。注释规范。注释的目的是解释代码本身复杂或不直观的部分当代码本身的清晰度较高时注释应较少避免过多冗余的注释。注释不应该作用于不需要保留的代码如果一段代码不需要保留则应将其删除而不是将其注释。实际可以列举的代码规范性可以更多。虽然代码规范性可以列举出很多点但是其核心目的是一致的主要是提升可读性和降低维护成本。无论是个人开发的代码还是团队开发的代码遵循代码规范性提升可读性和降低维护成本都有助于提高效率和减少错误率。代码规范性的正面效果是显著的但是并不意味着代码规范性没有负面效果。代码规范性的负面效果也很明显为了遵循代码规范性需要花更多的时间主要体现在需要有更多的思考选择合适的命名、设计合适的代码结构、撰写合适的注释都需要花时间。正因为代码规范性既有正面效果也有负面效果所以实际写代码时不同场景的代码规范性要求也是有所不同的。不同场景的代码规范性要求实际写代码的场景有多种每种场景的代码规范性要求有所不同。有些场景下代码规范性的要求可以降低这并非说明代码规范性不重要而是综合考虑不同因素时的取舍。需要考虑的因素主要包括时间是有限还是充裕、协作参与人数与代码的生命周期长度。由于代码规范性的负面效果主要体现在写代码时需要有更多的思考、花更多的时间因此时间因素直接决定了是否有条件更好地落实代码规范性。以下列举 5 种不同的场景包括 3 种时间有限的场景和 2 种时间充裕的场景。时间有限的场景线上竞赛线上竞赛是由系统根据测试用例通过情况自行评分的算法竞赛。典型的线上竞赛包括 LeetCode 的周赛以及其他算法网站或平台的竞赛。线上竞赛的目标是在限定时间内完成并通过尽可能多的题目每道题目的通过标准是该题目的所有测试用例都运行通过结果正确且复杂度符合要求。大多数线上竞赛都会将用时作为得分相同时的排名依据因此线上竞赛的目标还包括用时最短。线上竞赛的场景下时间有限而且需要追求用时最短代码由一人完成代码的生命周期长度仅限于竞赛期间以及竞赛结束之后的较短时间段而且竞赛结束之后虽然可以被看到代码但是看代码的目的是排查作弊而不是检验代码规范性。线上竞赛时追求代码规范性并不会带来更多的收益只会产生更多的时间成本因此没有代码规范性的要求最明智的做法是放弃代码规范性。理论上线上竞赛不需要考虑代码规范性可以使用任意命名方式但是实际操作时通常会选择短命名或能体现含义的命名不会使用又长又不能体现含义的命名这也是遵循线上竞赛的目标的最佳决策。如果使用奇怪的变量名反而是不正常的行为。LeetCode 的周赛为了防止 AI 作弊会在题目中隐性加入一句使用指定变量名存储中间结果的要求这句要求在正常阅读时不会显示但是如果复制题目内容则会藏在题目内容中代码中出现奇怪变量名的选手必定是使用 AI 作弊的选手。虽然线上竞赛是最不需要考虑代码规范性的场景但是仍不建议完全放弃代码规范性。线上竞赛的系统可能会检测不同选手的代码之间的相似度如果存在相似度过高的情况则可能会被认定为抄袭作弊不排除误判的可能。由于线上竞赛时普遍追求变量名短节省时间因此为了避免和其他选手的代码出现相似度过高的情况可以在命名方面相对规范避免单字母变量名而是尽可能使用表示特定含义的单词或单词缩写作为变量名可以很大程度降低和其他选手的代码相似度。求职机试求职机试是部分公司在招聘时给求职者做的线上机试大多考查数据结构和算法通常作为求职面试之前的环节。典型的求职机试平台包括 LeetCode 和 Codility。求职机试的目标是在限定时间内完成所有题目并尽可能得高分每道题目的得分根据测试用例的通过情况决定测试用例覆盖的情况包括各种不同类型的情况以及数据规模大的情况测试代码的正确性以及复杂度是否符合要求。求职机试和线上竞赛的不同之处在于求职机试并不是多人同时参与的不存在实时排名也不会将用时作为评分依据因此目标不包括用时最短。求职机试的场景下时间有限代码由一人完成代码的生命周期长度仅限于机试期间以及机试结束之后的较短时间段因此代码规范性的要求较低应优先考虑正确性和复杂度符合要求。但是求职机试的代码可能会被面试官看到因此代码规范性的要求并非没有在用时较短的情况下可以追求代码规范性。求职面试求职面试是公司在招聘时由面试官与求职者面对面交谈的考查形式是求职的核心环节。面试包括线下的现场面试和线上的音视频面试。求职面试的问题会涉及多个方面包括代码题代码题可能考查数据结构和算法也可能考查其他方面。求职面试和求职机试的不同之处在于求职面试多了求职者和面试官的交谈过程面试官也能看到求职者写代码的全过程。虽然时间仍有限代码几乎都由求职者一人完成代码的生命周期长度仅限于面试期间以及面试结束之后的较短时间段但是由于面试官会看到求职者写代码的全过程面试官与求职者的交谈也会决定代码内容因此代码规范性的要求显著更高。求职面试中除了交叉面试之外大多数情况下的面试官都是将来的同事和领导。从面试官的角度可以将面试看成是与未来的同事或下属的一次合作从求职者的角度可以将面试看成是与未来的同事或领导的一次合作。既然是合作就是一次模拟的团队写作代码规范性是面试中的一个重要考查项很大程度反映了求职者的未来工作表现。时间充裕的场景题解代码在 LeetCode 等算法和代码的网站或平台除了做题之外还有题解功能。题解的作用是给其他人展示解题思路和正确的代码。虽然题解代码由题解作者一人完成但是题解发布之后会被很多人阅读代码的生命周期长因此题解代码的代码规范性的要求显著高于线上竞赛和求职机试也高于求职面试。题解代码的代码规范性的重要性体现在如下方面。作为题解无论是思路还是代码都是给读者看的因此必须做到思路清晰、可读性强否则就失去了题解的意义。求职面试的面试官对题目非常熟悉也知道正确思路通过阅读求职者的代码可以快速判断解法是否正确以及是否符合复杂度要求。题解的读者的水平可能相差很多虽然不乏高手但是也有很多读者是首次遇到该题的新手规范的代码更有助于读者理解正确的解题思路。工程代码工程代码是工作场景下由团队完成的代码其代码规范性的要求最高显著高于题解代码的代码规范性。工程代码和题解代码相比其代码规范性的重要性体现在如下方面。题解代码是解决特定的问题的问题规模小代码通常较短而且只需要处理合法输入不需要处理非法输入等其他情况工程代码处理的场景显著更复杂代码量更大而且除了功能本身之外还有错误处理、非法输入兼容、接口设计、可扩展性等大量工程要求。题解代码是静态的只要题目不变题解代码就不需要变工程代码是动态的需要长期迭代代码会被很多人阅读和修改。工程代码的场景和前面提到的场景都不同的点在于长期迭代和多人参与这一点决定了工程代码的代码规范性的要求远高于前面提到的场景。前面提到的场景即使代码会给其他人看代码也是静态和只有一人参与的代码完成之后几乎不存在更新代码的成本工程代码的场景代码的长期迭代和多人参与决定了更新代码的成本极高因此非常有必要降低更新代码的成本。工程代码如果不遵循代码规范则可能在最初阶段用时短、时间成本低但是到后期维护与修改时必然会因为不遵循代码规范而付出更多的时间成本而且多付出的时间成本远超过最初阶段节省的时间成本。反之遵循代码规范虽然从短期而言会多花时间成本但是从长期而言可以节省更多的时间成本长期节省的时间成本远超过短期多花的时间成本。因此工程代码的场景下遵循代码规范是完全有必要的。总结不同场景的代码规范性要求不同并不表示特定场景下的代码规范性不重要或错误而是综合考虑不同因素时的取舍。在时间有限的场景下代码规范性要求相对较低特别是线上竞赛的纯系统评分的场景代码规范性要求甚至可以没有。这并不表示遵循代码规范性是错误的而是有优先级更高的核心目标并且放弃代码规范性并不会影响达到核心目标反而可以节省时间更好地达到核心目标。虽然时间有限但是在条件允许且不影响核心目标的情况下遵循代码规范性总是更好的。在时间充裕的场景下代码规范性要求会显著更高。由于不需要赶时间因此没有优先级更高的目标要求放弃代码规范性此时应将代码规范性作为写代码的最高目标。