为什么大家用这种方式做注释

maolz21 2005-04-18 12:19:38

'// <summary>
'// 返回错误信息
'// </summary>

我看到有好几个不同人写的代码都是这样做注释，这样写注释有什么好处吗

...全文

84 2 打赏收藏转发到动态举报

写回复

2 条回复

切换为时间正序

请发表友善的回复…

发表回复

xuanxingmin 2005-04-18

打赏
举报

回复

这只是一种书写习惯的问题。
因为C样式的注释就是这个样子的。
如在C++,Java或C#里面都可以这样写,因为他们已经看惯了这样的注释方式。说到好处只能说是给经常使用C类型注释语言的人一个方便而已。　

呵呵，个人观点

//这是C语言、C＋＋、JAVA、JAVASCRIPT、C＃的注释

'这是VB、VBSCRIPT的注释

c97164 2005-04-18

打赏
举报

回复

习惯了c

现在的项目开发里，代码注释就像程序员的头发，越来越少。尤其是国内，这种现象不仅是在小公司小团队中司空见惯，就算在大公司，以及大团队中的开源项目里，也是屡见不鲜。上图是我在阿里的 Druid 项目源码里截的。DruidDataSource 是 Druid 重度使用的核心类，非常关键，可是哪怕这种关键的核心类，也见不到什么注释。没有注释对我们读代码带来了很多的不便之处。就像扔给你一个数码产品，上面堆叠着密密麻麻的功能按键，但是却没有给你说明书。那为什么代码注释消失了呢？我尝试总结一下原因

在编写C语言源代码时，应该多使用注释，这样有助于对代码的理解。在C语言中有两种注释方式：1.一种是以/*开始、以*/结束的块注释(block comment)；2.另一种是以//开始、以换行符结束的单行注释(line comment)。可以使用/*和*/分隔符来标注一行内的注释，也可以标注多行的注释。例如，在下列的函数原型中，省略号的意思是 open() 函数有第三个参数，它是可选参数。注释解释了...

IDEA自带的注释模板不是太好用，我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家，我不是专业玩博客的，写这篇文章只是为了让大家省事。这里设置的注释模板采用Eclipse的格式，下面先贴出Eclipse的注释模板，我们就按照这种格式来设置：类注释模板： ...

前言相信大家都会遇到这种情况：一周前自己写的代码，现在再拿出来看，发现读不懂了，“ 这代码是我写的？？？”。这时候，代码注释就可以发挥它的作用了——提高晦涩难懂的代码的可读性；注释可以起到隐藏代码复杂细节的作用，比如接口注释可以帮助开发者在没有阅读代码的情况下快速了解该接口的功能和用法；如果写的好，注释还可以改善系统的设计。既然注释这么多好处，为什么我们程序员还是不愿意写注释？ “代码都写不完...

背景使用Swagger的时候有一种痛苦，侵入性太强了。我个人又喜欢写注释，我理解注释写得越好，越能减少沟通的交流，节省人力，提高工作效率。所以想着使用Controller的注释和实体的注释，就能替换Swagger的***注解***。全网找下来，有实现这个功能的：github，但是我使用之后发现一些bug联系不上作者，而且我不会Kotlin，所以还是需要自己研究一下。设计 pom文件依赖因为考虑想开源给大家使用，这里没有去依赖顶层的pom文件。研究swagger的源码通过研究swagger的源码发

28,406

社区成员

356,946

社区内容

发帖

与我相关

我的任务

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

暂无公告

试试用AI创作助手写篇文章吧

+ 用AI写文章