c/c++ python命名规则--Apple的学习笔记
2020-09-19 本文已影响0人
applecai
我之前的公司大多采用的是匈牙利法(范围+类型+含义),我其实不太喜欢这样的命名方法,原因很简单,porting及变量范围更新不方便,严格意义上还需要更新变量名。
我个人喜欢驼峰法,因为书写便利。另外下划线法也可以接受,linux内核都是这样的方法。
今天还看到一种驼峰加下划线的方法。所以我今天想了下,再过一段时间,等我理论基础复习完毕,开始实践练习的话,需要把我的代码风格统一下一。每个公司有编码规范, 我作为一个c/c++ python编码业余爱好者,做着我的业余爱好产品或demo代码,我也需要自己给自己定义一个编码规范。
AppleCai的简易编码规范出炉
一,命名规则
RULE 1. 若是linux驱动开发则使用下划线法。
RULE 2. 若是应用开发则使用驼峰法。
二,函数注释规则
按照Doxygen的注释规则,这样做便于自动生成文档
RULE 3. 变量注释
/*< 变量含义 /
RULE 4. 函数注释
/ \brief
- \param
- \param
- \return
*/