OpenEdv-开源电子网

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

麻烦各位前辈看下我这样注释对吗?在公司里这样写会不会被骂?

[复制链接]

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
发表于 2020-5-24 23:40:06 | 显示全部楼层 |阅读模式
1金钱
麻烦各位前辈看下我这样注释对吗?在公司里这样写注释会不会被骂?是不是不规范,在下自学小白,很多不懂的,让各位见笑了,麻烦指点一下。
1.jpg
2.jpg
3.jpg

最佳答案

查看完整内容[请看2#楼]

教程主要是方便学员学习用的,实际工作中是不允许这么做的,首先我们要遵循的原则是代码自带注释,也就是看代码就很明了的知道是干什么的,这里主要是命名要规范化;其次,你这样注释把程序结构打乱了,会让人看得眼花缭乱,不建议这么做。你可以看看google当年出的关于c和c++的编码规范,我给你发到附件吧,这可是我一字一字整理的。
正点原子逻辑分析仪DL16劲爆上市
回复

使用道具 举报

22

主题

2251

帖子

0

精华

论坛元老

Rank: 8Rank: 8

积分
4471
金钱
4471
注册时间
2013-4-22
在线时间
335 小时
发表于 2020-5-24 23:40:07 | 显示全部楼层
long7qazzaq 发表于 2020-5-26 16:40
谢谢大神的回复,这样注释不会觉得更详细吗?我看到教程里也有类似的,这样是不是有什么缺点或不规范

教程主要是方便学员学习用的,实际工作中是不允许这么做的,首先我们要遵循的原则是代码自带注释,也就是看代码就很明了的知道是干什么的,这里主要是命名要规范化;其次,你这样注释把程序结构打乱了,会让人看得眼花缭乱,不建议这么做。你可以看看google当年出的关于c和c++的编码规范,我给你发到附件吧,这可是我一字一字整理的。 C语言软件编码规范.pdf (612.5 KB, 下载次数: 53)
回复

使用道具 举报

22

主题

2251

帖子

0

精华

论坛元老

Rank: 8Rank: 8

积分
4471
金钱
4471
注册时间
2013-4-22
在线时间
335 小时
发表于 2020-5-25 11:05:58 | 显示全部楼层
不建议这么做,注释尽量要精简
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-5-26 16:40:07 | 显示全部楼层
三叶草 发表于 2020-5-25 11:05
不建议这么做,注释尽量要精简

谢谢大神的回复,这样注释不会觉得更详细吗?我看到教程里也有类似的,这样是不是有什么缺点或不规范
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-5-27 01:00:55 | 显示全部楼层
希望多有大神可以指点一下
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-5-27 09:01:10 | 显示全部楼层
能麻烦大神详细说明下吗?真的不是很懂这方面,谢谢啦!
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-5-29 14:36:45 | 显示全部楼层
三叶草 发表于 2020-5-26 23:13
教程主要是方便学员学习用的,实际工作中是不允许这么做的,首先我们要遵循的原则是代码自带注释,也就是 ...

好的,太谢谢大神了,主要我有一段时间这么编程,身边也都是自学的朋友,夸我这样清晰明了易懂,我觉得有一定的道理,后来发现很多前辈们基本都没有我这样编写的,我一下子转不过弯来,很困惑,也不知道问谁好,想知道在工作中这样写,会不会不合格直接重写或被辞退什么的,我好提前改掉
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-5-29 23:47:29 | 显示全部楼层
三叶草 发表于 2020-5-26 23:13
教程主要是方便学员学习用的,实际工作中是不允许这么做的,首先我们要遵循的原则是代码自带注释,也就是 ...

想问下前辈身边有这么写的吗
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-6-1 10:16:00 | 显示全部楼层
三叶草 发表于 2020-5-26 23:13
教程主要是方便学员学习用的,实际工作中是不允许这么做的,首先我们要遵循的原则是代码自带注释,也就是 ...

主要我有一段时间这么编程,身边也都是自学的朋友,夸我这样清晰明了易懂,我觉得有一定的道理,后来发现很多前辈们基本都没有我这样编写的,我一下子转不过弯来,很困惑,也不知道问谁好,想知道在工作中这样写,会不会不合格直接重写或被辞退什么的,我好提前改掉
回复

使用道具 举报

22

主题

2251

帖子

0

精华

论坛元老

Rank: 8Rank: 8

积分
4471
金钱
4471
注册时间
2013-4-22
在线时间
335 小时
发表于 2020-6-1 10:18:19 | 显示全部楼层
long7qazzaq 发表于 2020-6-1 10:16
主要我有一段时间这么编程,身边也都是自学的朋友,夸我这样清晰明了易懂,我觉得有一定的道理,后来发现 ...

重写倒不至于辞退更不可能
回复

使用道具 举报

104

主题

313

帖子

0

精华

高级会员

Rank: 4

积分
893
金钱
893
注册时间
2014-11-13
在线时间
53 小时
 楼主| 发表于 2020-6-1 10:33:36 | 显示全部楼层
三叶草 发表于 2020-6-1 10:18
重写倒不至于辞退更不可能

那会有什么不好的地方吗
回复

使用道具 举报

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

本版积分规则



关闭

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

正点原子公众号

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

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

Powered by OpenEdv-开源电子网

© 2001-2030 OpenEdv-开源电子网

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