OpenEdv-开源电子网

 找回密码
 立即注册
正点原子全套STM32/Linux/FPGA开发资料,上千讲STM32视频教程免费下载...
查看: 5625|回复: 9

请教个关于程序注释的问题,谢谢了各位,刚刚发的一个没上传图片,不好意思

[复制链接]

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
发表于 2020-4-7 04:02:01 | 显示全部楼层 |阅读模式
1金钱
就是我看到韦东山老师的注释都很多1,2,3,4,或者a,b,c,d........类的步骤说明前缀,在现实中公司中项目程序里是否程序也都这样注释的?会不会显得冗杂或者不规范而被公司说?或者同事之间都不一样会。
谢谢了!

3.jpg
2.jpg
1.jpg
正点原子逻辑分析仪DL16劲爆上市
回复

使用道具 举报

88

主题

7377

帖子

5

精华

资深版主

Rank: 8Rank: 8

积分
14980
金钱
14980
注册时间
2013-11-13
在线时间
1823 小时
发表于 2020-4-7 12:22:29 | 显示全部楼层
真正作项目的时候不用添加这些1,2,3的注释,只要添加一些必要的注释就行了
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-4-7 15:34:39 | 显示全部楼层
zuozhongkai 发表于 2020-4-7 12:22
真正作项目的时候不用添加这些1,2,3的注释,只要添加一些必要的注释就行了

谢谢大哥的回复,请问下,如果添加了,会不会显得很不规范或者觉得有啥问题
回复

使用道具 举报

22

主题

2251

帖子

0

精华

论坛元老

Rank: 8Rank: 8

积分
4471
金钱
4471
注册时间
2013-4-22
在线时间
335 小时
发表于 2020-4-8 11:08:43 | 显示全部楼层
我一般很少写注释,尽量让代码变的简单明了
回复

使用道具 举报

58

主题

6291

帖子

1

精华

资深版主

Rank: 8Rank: 8

积分
11406
金钱
11406
注册时间
2014-4-1
在线时间
1282 小时
发表于 2020-4-8 11:48:11 | 显示全部楼层
long7qazzaq 发表于 2020-4-7 15:34
谢谢大哥的回复,请问下,如果添加了,会不会显得很不规范或者觉得有啥问题


没啥问题。
如果“不规范”,你说的老师不就这样做了吗?
除非你们公司规定,不许写注释。貌似也没有这样的公司。

回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-4-8 14:15:34 | 显示全部楼层
我的意思是注释,都是每句都1,2,3,4这样注释会不会不好,过于冗杂
回复

使用道具 举报

2

主题

712

帖子

0

精华

金牌会员

Rank: 6Rank: 6

积分
2178
金钱
2178
注册时间
2018-8-27
在线时间
258 小时
发表于 2020-4-8 17:26:40 | 显示全部楼层
long7qazzaq 发表于 2020-4-8 14:15
我的意思是注释,都是每句都1,2,3,4这样注释会不会不好,过于冗杂

人家教学的嘛  注释写的清楚好让你理解,真正项目开发的时候肯定不需要这样子做,有必要的地方才会做注释。
森罗万象
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-4-10 21:41:50 | 显示全部楼层
xiaotaotao 发表于 2020-4-8 17:26
人家教学的嘛  注释写的清楚好让你理解,真正项目开发的时候肯定不需要这样子做,有必要的地方才会做注释 ...

那如果都这么注释了,会有问题吗?会不会觉得不可以这样
回复

使用道具 举报

7

主题

101

帖子

0

精华

中级会员

Rank: 3Rank: 3

积分
317
金钱
317
注册时间
2017-9-16
在线时间
80 小时
发表于 2020-4-12 21:50:15 来自手机 | 显示全部楼层
可以看看doxygen这类工具
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则



关闭

原子哥极力推荐上一条 /2 下一条

正点原子公众号

QQ|手机版|OpenEdv-开源电子网 ( 粤ICP备12000418号-1 )

GMT+8, 2024-11-22 16:47

Powered by OpenEdv-开源电子网

© 2001-2030 OpenEdv-开源电子网

快速回复 返回顶部 返回列表