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

    远离不写注释的程序员

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

    19640

    代码注释:程序员的隐形艺术

    代码注释:程序员的隐形艺术 在编程的世界里,代码注释是一份沉默的契约,它既是程序员与未来自己对话的桥梁,也是与他人沟通的窗口。然而,对于这份契约的履行,程序员们的态度却颇为复杂。...那么,我是如何看到程序员不写注释这一现象的呢? 1.观点与故事:代码注释的个人历程 作为一个有着多年编程经验的开发者,我深知代码注释的重要性。在我早期的编程生涯中,我曾因为忽视注释而付出过代价。...2.原因探究:为何程序员不爱写注释? 时间压力:在项目紧张的截止日期面前,注释往往被视为可以牺牲的部分。 自信过剩:有时候,程序员对自己的代码过于自信,认为代码逻辑清晰到无需注释。...懒惰心理:写注释需要额外的努力和时间,而懒惰是人类的天性,这在程序员中也不例外。 代码更新频繁:在快速迭代的开发环境中,代码的快速变化可能会让注释显得过时和多余。 3.如何写出漂亮的注释?...遵循标准:遵循团队或项目的注释标准和格式,保持一致性。 4.深入分析:代码注释的多面性 代码注释不仅仅是一种技术实践,它还涉及到心理学和社会学的层面。为什么有些程序员会忽视注释?

    6610

    代码注释对于程序员重要吗?

    程序员对代码注释可以说是又爱又恨又双标……你是怎么看待程序员不写注释这一事件的呢? 代码注释的重要性 代码注释是指在程序代码中添加的解释性说明,用于描述代码的功能、目的、使用方法等。...代码注释对于程序的重要性主要体现在以下几个方面: 提高代码的可读性:代码注释可以帮助开发人员和其他人员快速理解代码的功能和目的,避免阅读代码时产生歧义。...总之,代码注释是程序开发中必不可少的一部分,它可以帮助提高代码的可读性、可维护性和质量。开发人员应该养成写代码注释的习惯,以提高程序的开发效率和质量。...你认为程序员不写注释的原因是什么 程序员不写注释的原因有很多,主要有以下几点: **时间压力:**在项目有紧迫截止日期的情况下,程序员可能会觉得写注释是一个额外的任务,会增加开发时间。...程序员应该养成写代码注释的习惯,并注意避免常见的代码注释错误,以提高注释的质量。

    20210

    「  『Java』注释与helloworld程序的解释  」

    - Java注释 什么是注释,注释的作用是什么?...1- 对Java源代码的解释说明 2- 注释并不会被编译到.class字节码中(一个好的开发习惯应该是多行注释,目的:增强可读性) - 注释写法(三种) ①单行注释 //单行注释,仅注释当前行 ②多行注释.../* 多行注释 多行注释 ... */ ③javadoc注释 注意:该注释会被Javadoc程序(Javadoc.exe)解析并生成帮助文档 /** *javadoc注释 *javadoc...注释 *javadoc注释 ... */ 对helloworld程序的解释 - 整段展示 Public class HelloWorld { Public static void main...HelloWorld 注意:类体中,不允许直接编写Java语句,除了声明变量 Public static void main (String [] args) 该句表示定义一个公开的静态的主方法,是一个程序的执行入口

    30010

    Java之入门程序及注释

    开始写第一个Java程序 2. 关于java源程序当中的注释: 1. 开始写第一个Java程序 安装JDK【JDK一般需要从oracle的官网下载】 JDK、JRE、JVM 三者的关系 ?...开发HelloWorld.java源程序【注意大小写】 将HelloWorld.java源程序通过javac工具进行编译: 首先需要解决的问题是:javac命令是否可用 打开DOS命令窗口...关于java源程序当中的注释: 什么是注释?注释的作用是什么?...出现在java的源程序当中,对java源代码的解释说明 注释不会被编译到.class字节码文件当中 一个好的开发习惯应该是多编写注释,这样程序的可读性增强。| java中的注释怎么写呢?...单行注释 //单行注释,只注释当前行 多行注释 /* 多行注释 多行注释 */ javadoc注释 /** * 这里的信息是 javadoc 注释 * @author 作者名字 * @version 版本号

    51410

    程序员不写注释:探讨与反思

    一、为什么程序员不写注释 当程序员选择不写注释时,通常有一系列常见原因,这些原因可以影响他们的决策和行为。同时,这个决策可能会带来多方面的影响和后果。...程序员可能感到时间压力,需要尽快完成任务,因此可能会牺牲写注释的时间以加速开发进程。 马虎或忘记: 有时程序员可能会在编写代码时变得马虎,或者在完成后忘记添加注释。...总体来说,程序员不写注释的原因可能包括时间压力、马虎或忘记以及缺乏对注释重要性的意识。...三、如何改进程序员的注释习惯 要改进程序员的注释习惯,可以采取以下措施: 3.1 教育和意识 培养好的注释习惯:通过教育和培训,帮助程序员养成良好的注释习惯。...分享最佳实践示例,以帮助程序员理解何时以及如何添加注释,以使代码更易理解。 3.2 工具和自动化 使用注释生成工具:引导程序员使用工具来自动生成文档和注释。

    31720

    【Python】Python 注释 ( 单行注释 | 多行注释 | 代码示例 )

    文章目录 一、Python 注释 1、单行注释 2、多行注释 3、代码示例 单行注释 : # 单行注释 多行注释 : """ 多行注释 多行注释 多行注释 """ 一、Python 注释 ---- Python...注释 可以 对 代码 进行解释说明 , 代码中的 注释 不会被执行 , 可以 增加代码的可读性 ; 1、单行注释 单行注释 : Python 中的 单行注释 以 # 开头 , # 右边是注释内容 ;...单行注释 中 , # 与 注释内容 建议使用 空格隔开 , 这是 Python 官方的建议 , 建议大家都遵守该规范 ; 单行注释 可以 独立占一行 , 也可以 写在代码右侧 ; 在 C / C++ /...之间添加空格 , 警告信息消失 ; 代码示例 : 下面的代码中 , 第一行中的 单行注释 独占一行 , 第二行中的 单行注释 在代码的右侧 ; # 单行注释 print(123) #...单行注释 2、多行注释 Python 多行注释 使用三个双引号 引起来 ; 三个双引号 即可以进行单行注释 , 又可以多行注释 , 代码如下 : """ 多行注释 """ """ 多行注释

    5.2K40

    如何快速删除程序中的所有注释

    如果你下载了他们的源代码,会发现一个现象,他们删除了所有的注释。原因很复杂,我们不过多猜测。因为在一些特殊情况下,确实存在需要删除注释的需求!...这里说一下如何实现删除一个工程里所有的注释,这样的功能。注意,这里说的删除注释,不是说之前有双斜线,然后把双斜线去掉。而是要把注释内容去掉! ? 方法分两种: 第一种,纯手工!...使用方法很简单,点击左上角的“Open”按钮,选择程序文件。文件类型可以是c、cpp、js、java、php等,具体可以看软件。但是不支持文件夹,所以只能选择文件。...因为去除注释的操作是直接覆盖原文件,所以操作之前一定要做好备份。 另外,无论是手工操作,还是软件操作,都是有隐患的!....*/" 但如果程序中要打印这样的信息,它会把打印信息搞坏,自然不会得到我们想要的结果。 所以,使用有风险,操作需谨慎! 操作完之后,编译一下,看是否有错误!最好再对照一下!

    6.6K10
    领券