首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

远离注释的程序员

注释的程序员才是好程序员 问:程序员最讨厌什么样的同事? 答:注释 问:程序员最讨厌干什么?...答:写注释 这仿佛成了一个死循环 大家都有过这样的经历 灵感上来了,疯狂敲代码 大几百行写完 真有成就感 但是队友不高兴了 没注释看不明白 所以,现在是否写注释 已经从行业约束问题 降低到最基本的道德问题了...行注释和块注释 一般注释就两种 行注释和块注释 针对不同的语言略有差异 Java 用 // SQL 用 -- XML 用 其他配置或脚本用 ## 都比较类似 然后部分语言支持块注释 类似 /* 这种首尾包围的形式...String secretText=sm3.digestHex(data); // 执行加密字符串 System.out.println(secretText); // 输出结果 } 有注释之后...整个代码理解会更清晰 但是实际工作中 除了部分复杂算法 其实没有必要写到这么细 所以大部分时候 都建议写文档注释 包括 类、属性、方法等 JavaDoc标记 Java语言有一套专门的注释规则 可以形成标准文档

17640

为什么我建议你写注释?

注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败,我用了失败一词,其实是说真的。注释总是一种失败,是因为我们无法找到不用注释就能表达这段代码含义的方法。...并不是不让你真的不用注释,而是有些时候,用注释是因为我们怕其他的开发者在我们的代码的时候,看不懂我们的代码从而去加注释,那么我们为什么写出其他开发者一目了然的代码呢?...为什么建议写注释? 为什么我们极力贬低注释?因为注释跟代码一样,注释会撒谎,但这并不是我们有意的写一些撒谎的注释。...所以,尽管有时候也需要注释,我们也该多花心思尽量减少注释量。 注释美化代码?...有些注释是必须的也是有利的,不过,唯一真正好的注释是你想办法去把你想表达的事物用代码表达出来。

1.2K20

程序员注释:探讨与反思

一、为什么程序员注释 当程序员选择注释时,通常有一系列常见原因,这些原因可以影响他们的决策和行为。同时,这个决策可能会带来多方面的影响和后果。...以下是详细阐述为什么程序员注释的常见原因以及这种决策可能导致的影响和后果: 1.1 常见原因: 时间压力: 在项目开发中,时间通常是一项关键资源。...新加入的团队成员或同事可能无法快速融入项目,因为缺少文档和注释来解释代码的功能和设计。 总体来说,程序员注释的原因可能包括时间压力、马虎或忘记以及缺乏对注释重要性的意识。...三、如何改进程序员的注释习惯 要改进程序员的注释习惯,可以采取以下措施: 3.1 教育和意识 培养好的注释习惯:通过教育和培训,帮助程序员养成良好的注释习惯。...集成注释检查:在开发环境中集成注释检查工具,以便在编写代码时检测缺失或不合规的注释。这可以通过静态代码分析工具来实现,帮助程序员及时发现并修复注释问题。

24720

js】如何正确的写代码注释

错误注释 你的注释是不是这样的? //时间戳日期格式化函数 function formTime(time,isyear){ } 亦或者是这样的?.../* 时间戳日期格式化函数 */ function formTime(time,isyear){ } 简单的变量声明之类的内容可以进行简单注释,但是函数就不能这样做了,要知道注释的作用是一种为了让代码更易读...正确注释 正确的注释 就是文档注释,先来看看是什么样子。...time 接受用户传来的时间戳 * @param {Boolean} isyear 是否要显示年月日 * @example formTime('3434322332',true) 格式化时间戳并显示年月日...npm install jsdoc -g 基本使用 jsdoc 文件名 其他的使用方式可以去官网查看 jsdoc 33.js 执行完此命令,会生成一个out文件夹,查看里面的index页面即可,右边侧边栏会显示函数的使用

17520

优秀的程序员真的注释吗?

没办法,我的解决办法就是,看懂一行就加一行注释,毕竟注释总比代码要容易理解啊。...写注释不是我们的错,软件本来就是复杂的。尤其是我们这些英语不是主力语言的人来说,注释显得尤为重要。...你可能会忘记代码是干嘛的,但我敢保证,注释能够唤醒你的记忆。 ? 写出好的、有意义的注释其实是有难度的,就像写代码一样。在追求卓越的路上,代码和注释其实是相辅相成的。...注释会让你的代码更易阅读,代码会让你的注释更富有逻辑。 即便是你的代码已经优雅到不需要注释,那只是在你的层面上。对于你的同事,你代码后来的负责者,就不一定了。...在大牛们看来,要让一个新人快速成长,最好的办法就是把没有注释的代码扔给他看。 纯属扯淡,恐怕这个新人没入门就放弃了吧?我已经三十一岁了,,我已经十八岁了,还不会游泳呢?

62410
领券