注释到底是写给谁看的?
如题,是:
给自己看的?
给牛人看的?
给普通程序员看的?
给正在学习编程的人看的?
给刚入门编程的新手看的?
写注释的目的是为了什么?方便别人更好的理解代码?
有人说:
1.中英混用让程序不美观
2.半角全角
3.中英混用让某些工具混乱
4.中英混用带来不必要的编码麻烦,据我所知,某些编译器以及老版本的gcc根本就没法处理中文
5.用了中文,就基本决定这个程序只算个玩笑作品
6.中文表达过于灵活,比英文更加模棱两可
所以,原则是不要在英文编程语言中使用中文注释,除非是中文编程语言。养成好习惯。
[解决办法]
注释主要是写给别人看的 比如公司要把你赶出门了 如果你写的代码没注释的话代码就废了
在比如别人通过木马或其他手段得到了你的代码,如果没有注释,那别人辛苦偷的东西也白费了
所以注释非常重要 非常非常重要
[解决办法]
给维护人员看的,一般开发人员和维护人员不是同一人
[解决办法]
给需要看的人看的。反正主要不是写给自己看的。
[解决办法]
自己也需要看的,比如1年以后你再看现在的代码,如果没有注释会很晕
[解决办法]
谁看谁知道。包括你自己。 我自己上月写的代码,没有注释的话,我自己看起来都费劲,所以我支持留注释(有效注释)
[解决办法]
留给看你代码的淫看滴。。。
[解决办法]
看到自己的旧注释
总是觉得自己一直活在匆忙之中
什么都没来得及去做
真让人悲伤
[解决办法]
推荐doxygen,可以将注释生成文档,当然了,需要你按规范的格式去写注释。
头文件中的注释,要详细写,各种参数如何使用,返回值等等。这样方便调用者使用时查看。
源代码中,必要的地方添加注释,特别是有些比较巧妙的实现之处,加上注释。这样过段时间你再看这段代码,就能想起来是咋回事了,其他人看也容易理解。
至于注释的语言,LINUX相关开发最好用英文注释。因为由于格式的问题一不小心就会变成乱码。如果英文水平一般,那就用中文。
比如,海思的注释,全是中文。一目了然,通俗易懂。
[解决办法]
如果程序你自己写,注释是写给自己看的,不要考虑你离开以后的事情。
如果程序不是你自己写,你是项目主管,那一定要说注释是必须的。
很多时候看不懂别人的程序,那是因为在别人的程序里,代码格式,变量的命名这些都是由自己的风格的。
对于写程序的人而言,这些也是注释。
但是,接口文档是必须的,因为这是你和其他程序之间的契约。
[解决办法]
码农自古谁无死,
留取注释照汗青。
(^_^)