请前辈们帮我看看注释写得是否规范

作者:用户 来源:互联网 浏览:377 次 时间:2016-09-21 11:43:22

请前辈们帮我看看注释写得是否规范 - 摘要: 请前辈们帮我看看注释写得是否规范这种注释对于学习写程序来说的人有用,但是对于真正的程序来说没用。注释不是把每行代码用中文再写一遍,任何程序员都可以得到这些表面的信息。注释应该少而精炼,强调程序的实现意

问题描述

请前辈们帮我看看注释写得是否规范

解决方案

这种注释对于学习写程序来说的人有用,但是对于真正的程序来说没用。
注释不是把每行代码用中文再写一遍,任何程序员都可以得到这些表面的信息。注释应该少而精炼,强调程序的实现意图和接口的调用规范。

解决方案二:

给程序添加注释是帮助别人理解代码 像你这样几乎每行都有注释 反而会增加别人阅读时困难. 注释只需要加载需要加的地方帮助别人理解代码.
像下面这种注释根本不需要添加:
X x(5); Y(y); Z(z); //实例化对象

解决方案三:

上面说的很对,不过实际工作中有些人没有写注释的习惯(比较坑),让后面的人看的很头疼。

解决方案四:

网上有windows操作系统泄露的源代码,还有liunx的源代码,mfc的源代码,各种开源软件的源代码,你可以对照看看它们,去理解我说的少而精炼是什么意思。
另外你的格式过于拘谨了,其实也没有必要。如果你看windows泄露的源代码,你会发现人家很有幽默感滴。里面甚至有各种开玩笑、调侃、抱怨和看上去扯淡的东西。

解决方案五:

给别人看如果不是为了防止别人的写详细点;
如果是防止别人盗取的就用""无字天书""来注释。
如果是写给自己看的写的自己看着舒服明白就可以了。

解决方案六:

注释太多了,不能瞬间感觉到重点的注释信息在哪里

解决方案七:

我个人认为,注释不一定就是这种形式,高层次的注释应该是让你的变量和函数等标识符见名知意,对于各个逻辑处理的地方给出简明扼要的提示。

解决方案八:

感觉注释太复杂了吧。看不到要点

解决方案九:

感觉注释太复杂了吧。看不到要点

解决方案十:

个人感觉注释不需要多,明确就好。
注释在函数上说明参数返回值及作用。
当然,如果变量名和函数名取得好,注释也不用了。

【云栖快讯】阿里云栖开发者沙龙(Java技术专场)火热来袭!快来报名参与吧!  详情请点击
云栖社区(yq.aliyun.com)为您免费提供请前辈们帮我看看注释写得是否规范相关信息,包括 javadoc注释规范,doxygen注释规范,js注释规范,c 注释规范,php注释规范的信息 ,所有请前辈们帮我看看注释写得是否规范相关内容均不代表云栖社区的意见! 该页面h5页面的地址是:https://m.aliyun.com/yunqi/wenzhang/show_83247,您可以点击请前辈们帮我看看注释写得是否规范-手机站访问。
双十二
弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率

40+云计算产品,6个月免费体验

现在注册,免费体验40+云产品,及域名优惠!

云服务器9.9元/月,大学必备

热点导航