在线咨询
eetop公众号 创芯大讲堂 创芯人才网
切换到宽版

EETOP 创芯网论坛 (原名:电子顶级开发网)

手机号码,快捷登录

手机号码,快捷登录

找回密码

  登录   注册  

快捷导航
搜帖子
查看: 445|回复: 2

[求助] 平台中的一些命名注释有相对统一的风格吗?

[复制链接]
发表于 2023-8-12 13:21:08 | 显示全部楼层 |阅读模式

马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。

您需要 登录 才可以下载或查看,没有账号?注册

x
平台中写的task和function还有成员变量这些有相对统一的风格吗,还有注释的风格,想写的规范一点,这样看起来舒服一些,还方便维护
发表于 2023-8-12 14:05:59 | 显示全部楼层
本帖最后由 轩辕志瑜 于 2023-8-12 14:25 编辑

常见的几种变量命名方法,找一种喜欢的然后统一代码风格。

1.下划线命名法,使用下划线分割多个单词,这种方式是C语言中常用的,在C语言类程序中经常使用使用,好处是字母全部小写,看起简洁。例如:int books_num = 100; // 书本数量,void add_book(...); // 增加书本函数,void print_books(...); // 显示所有书本信息。

2.小驼峰式命名法,第一个单词首字母小写,后面的每个单词的首字母大写。例如:int booksNum = 100;,void addBook();,void printBooks();。

3.大驼峰式命名法,这种又称为帕斯卡命名法(Pascal命名法),每个单词的首字母都大写。例如:int BooksNum = 100;,char *BookName;,void AddBook();,void PrintBooks();。

4.匈牙利命名法,起源于Windows环境编程中,据说是一名匈牙利的程序员发明,该命名法稍微复杂些,名字以小写字母作为前缀,该前缀可以表示变量的类型、作用域等信息。一般的格式是 属性+类型+描述,属性可以是小写字母加上下划线,看到变量名就可以知道变量的类型(整型、浮点型、指针类型等),知道其作用域(全局变量还是局部变量),知道其作用。例如:int iBooksNum = 100; 其中,i缩写表示整型。static char *s_psBookName; 其中,s_表示静态变量,p表示指针类型,s表示字符串。

当然你也可以自定义命名法按自己喜欢的方式命名然后写成规范文档给看代码和接手项目的人了解你的代码风格。

注释也是找一种喜欢的然后写个格式统一风格,比如:
// 函数功能:
// 创建作者:
// 创建时间:
// 最后一次维护人员:
// 最后一次修改时间:
// 待修复问题:

或者

/**
** 函数功能:
** 创建作者:
** 创建时间:
** 最后一次维护人员:
** 最后一次修改时间:
** 待修复问题:
**/



发表于 2023-8-12 20:56:13 | 显示全部楼层
您需要登录后才可以回帖 登录 | 注册

本版积分规则

关闭

站长推荐 上一条 /2 下一条

小黑屋| 关于我们| 联系我们| 在线咨询| 隐私声明| EETOP 创芯网
( 京ICP备:10050787号 京公网安备:11010502037710 )

GMT+8, 2024-4-28 07:18 , Processed in 0.016838 second(s), 6 queries , Gzip On, Redis On.

eetop公众号 创芯大讲堂 创芯人才网
快速回复 返回顶部 返回列表