搜索

[STM32] 这个程序注释中的1,2,3,4需不需要去掉,想请教下

[复制链接]
706|32
 楼主 | 2020-5-29 14:48 | 显示全部楼层 |阅读模式
本帖最后由 编号27149 于 2020-5-29 14:50 编辑

file:///C:/Users/HP/Desktop/1.jpg
1.jpg

使用特权

评论回复

评论

chy435116 2020-6-1 14:50 回复TA
虽然我看不懂,单不代表我推销电子化工辅料 (三防漆.导热胶.灌封胶.结构胶)详情QQ191203477 
 楼主 | 2020-5-29 14:49 | 显示全部楼层
这样注释是不是不太好?
1.jpg
2.jpg
3.jpg

使用特权

评论回复
 楼主 | 2020-5-29 15:11 | 显示全部楼层
希望有前辈请教下

使用特权

评论回复
| 2020-5-29 15:27 | 显示全部楼层
都不知道你要干嘛
是不需要避障功能吗?
那就把整个函数去掉呀。
无论如何,只要能实现你要的功能就行。

使用特权

评论回复

评论

chy435116 2020-6-1 14:51 回复TA
虽然我看不懂,单不代表我推销电子化工辅料 (三防漆.导热胶.灌封胶.结构胶)详情QQ191203477 
| 2020-5-29 17:17 | 显示全部楼层
这么多延时,实时性有保障吗

使用特权

评论回复
 楼主 | 2020-5-29 23:49 | 显示全部楼层
LcwSwust 发表于 2020-5-29 15:27
都不知道你要干嘛
是不需要避障功能吗?
那就把整个函数去掉呀。

我是想问下,我这么注释对不对,1,2,3,4什么的要不要去掉?在公司里这么写是不是不规范?

使用特权

评论回复
 楼主 | 2020-5-29 23:50 | 显示全部楼层
ayb_ice 发表于 2020-5-29 17:17
这么多延时,实时性有保障吗

我是想问下,我这么注释对不对,1,2,3,4什么的要不要去掉?在公司里这么写是不是不规范?

使用特权

评论回复
| 2020-5-30 07:09 | 显示全部楼层
编号27149 发表于 2020-5-29 23:49
我是想问下,我这么注释对不对,1,2,3,4什么的要不要去掉?在公司里这么写是不是不规范? ...

哦,注释看起来是对的,1234什么的不用去掉,看起来越详细越好,让小白也能看明白就更好。
规范要看公司的要求,我也不知道,网上应该能查到一些规范。

使用特权

评论回复
 楼主 | 2020-5-30 09:56 | 显示全部楼层
LcwSwust 发表于 2020-5-30 07:09
哦,注释看起来是对的,1234什么的不用去掉,看起来越详细越好,让小白也能看明白就更好。
规范要看公司 ...

我想问下,你也是这么1,2,3,4注释的吗?或者你身边人这么注释的吗?

使用特权

评论回复
| 2020-5-30 10:02 | 显示全部楼层
看个人习惯吧,我是不喜欢这种1234的

使用特权

评论回复
| 2020-5-30 12:04 | 显示全部楼层
强烈建议注释不要用中文!毕竟编译器不是国产的,你用中文注释,换到别的环境极有可能变乱码了,自己都有可能看不懂,更别说别人了。注释常用的方法有这么两种:
1、
//.......
Function();

2、
Function();  /* ............. */

当然了,互换也可以。

使用特权

评论回复
| 2020-5-30 12:43 | 显示全部楼层
编号27149 发表于 2020-5-30 09:56
我想问下,你也是这么1,2,3,4注释的吗?或者你身边人这么注释的吗?

程序如果只给自己看自然没必要写这么多注释。
身边人写的注释也不多,主要是咱公司也没严格的管理,基本就各管各的,没在意这些。
写注释是一种好习惯,应当保持,万一哪天自己都忘了程序的功能呢?一看注释就能记起。
正点原子的例程可以参考一下。

使用特权

评论回复
| 2020-5-30 13:03 | 显示全部楼层
注释按照公司规范来就可以了,公司没有规范就按自己的习惯来。
如过想做更高标准,就参考各大厂的编程规范

使用特权

评论回复
 楼主 | 2020-5-30 13:21 | 显示全部楼层
dalarang 发表于 2020-5-30 10:02
看个人习惯吧,我是不喜欢这种1234的

为什么?你身边的人有这么注释的吗

使用特权

评论回复
 楼主 | 2020-5-30 13:22 | 显示全部楼层
梦幻泡影 发表于 2020-5-30 12:04
强烈建议注释不要用中文!毕竟编译器不是国产的,你用中文注释,换到别的环境极有可能变乱码了,自己都有可 ...

像标题中1,2,3,4,5这样注释的现实工作中,你身边的有吗?

使用特权

评论回复
 楼主 | 2020-5-30 13:24 | 显示全部楼层
LcwSwust 发表于 2020-5-30 12:43
程序如果只给自己看自然没必要写这么多注释。
身边人写的注释也不多,主要是咱公司也没严格的管理,基本 ...

我以前是模仿正点原子注释的,后来不知道怎么也1,2,3,4,5了起来,感觉好像也没什么人这么注释,所以很纠结矛盾,感觉1,2,3,4,5这样好像更仔细清晰,但是为什么大家又都不这么写,糊涂了

使用特权

评论回复
| 2020-5-31 07:58 | 显示全部楼层
自己能看明白的,没必要都去注释

使用特权

评论回复
| 2020-5-31 08:33 | 显示全部楼层
不需要去掉,这种习惯很好,不要去在意别人说什么,因为在中国某部分心底是不写最好,保密到只有自己能看最理想。美其名曰,保护自己。程序中用程序延时是不好,任务单一无所谓,可以优化的,不是啥大毛病。

使用特权

评论回复
 楼主 | 2020-5-31 12:11 | 显示全部楼层
一事无成就是我 发表于 2020-5-31 08:33
不需要去掉,这种习惯很好,不要去在意别人说什么,因为在中国某部分心底是不写最好,保密到只有自己能看最 ...

你好,谢谢回答,主要是我那个注释很多人说不规范,冗杂什么的,说公司里这么写是不合格的,最后都要重写或者开除什么的,仔细想想好像真没什么人像我这么写,除了教程里

使用特权

评论回复
| 2020-6-1 09:08 | 显示全部楼层
编号27149 发表于 2020-5-30 13:22
像标题中1,2,3,4,5这样注释的现实工作中,你身边的有吗?

我一般不会写这么详细,因为工程太大,只注释重要部分。还有一个就是,变量最好也不要这样声明(比如S),换成是我就这么干:vDistance或者gDistance。仅供参考

使用特权

评论回复
扫描二维码,随时随地手机跟帖
您需要登录后才可以回帖 登录 | 注册

本版积分规则

我要发帖 投诉建议 创建版块 申请版主

快速回复

您需要登录后才可以回帖
登录 | 注册
高级模式

论坛热帖

关闭

热门推荐上一条 /4 下一条

在线客服 快速回复 返回顶部 返回列表