软件行业研发部开发工程师代码编写规范手册.docxVIP

软件行业研发部开发工程师代码编写规范手册

第1章基本原则

1.1代码可读性

代码是写给人类阅读的，远比写给机器执行更重要。可读性差的代码，就像一本乱写乱画的笔记，即便作者当时记得清晰，过几个月也可能自己都看不懂。想象一下，某个深夜，团队里另一个成员需要紧急修复一个线上bug，面对一堆命名混乱、逻辑跳脱的代码，效率会如何被拖垮？

可读性不是空泛的礼貌，而是具体的工程实践。变量名应当像“roadmap”而非“rmp”，函数名要反映其职责，如`calculateDiscountPrice`而非`calc`。遵循驼峰命名法（camelCase）或下划线命名法（snake_case）