规范写作,从我做起

171 阅读2分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第31天,点击查看活动详情 >>

写作注意事项

  • 空行加的位置:在每个类声明之后、每个函数定义结束之后都要加空行。在一个函数体内,逻揖上密切相关的语句之间不加空行 ,其它地方应加空行分隔。
  • 在一个函数体内,逻揖上密切相关的语句之间不加空行 ,其它地方应加上空行分隔。
  • 一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
  • 尽可能在定义变量的同时初始化该变量(就近原则)

命名代码规范

  • 类、函数声明用大写字母

image.png

  • 成员变量、参数用小写字母

image.png

  • 常量用大写字母、下划线区分

image.png

  • 静态变量,前加s_(前缀)

代码优先级规范

如果在编写程序时,对优先级有歧义,或者是对优先级了解不是很深,可以通过添加括号进行避免。

if语句规范

有经验的程序员往往在写if语句时,经常会看到if(NULL = p),这样做可以防止将if(p == NULL)写成
if(p = NULL),所以在写条件判断时,可以用括号这样隔开,防止写错。
我们以后在写代码的过程中,要检查我们代码的格式,避免代码的冗余,好的写作方式可以事半功倍,
我们在编程的过程中,好的写作规范可以让别人容易看懂,更好的与不同的层次编程人员更好的交互。