首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

代码注释的艺术,优秀代码真的不需要注释吗?

似乎和我们很类似,我们程序员届也有这 2 件相辅相成的事:最讨厌别人不写注释,更讨厌让自己写注释。 一段糟糕的代码,往往大家最低的预期是把注释写清楚,最合理的做法通常应该对代码做优化。...有注释的代码都存在着一些瑕疵,认为足够完美的代码是不需要注释的。...,读代码时代码本身就能很好的表达具体的含义,我们完全不需要看注释,并且注释也不会给我们提供更多有效的信息。...这里有非常多的空间是代码很难阐述或无法阐述的,配上注释的代码并非就是糟糕的代码,相反有些时候,注释还是好代码最棒的僚机。...我们不用过分在意我们的代码是否可以脱离注释,也不需要强调因为我们的代码符合什么原则,满足什么约定,所以代码是优秀的注释是冗余的。

56720
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

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

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

    5.2K40

    代码注释对齐

    图1 图2 感觉上我们认为图2是我们想要的注释对齐的效果。但感觉是不能拿来代码实现的。 所以我们需要定义什么叫注释对齐。如下图 假设代码部分的长度为CL,代码到//之间的长度为Width。...注释对齐实际上就是计算Width-CL,中间填充这么多个空格。 那么尝试定义注释对齐。 1.内存对齐方式 参考计算机内存对齐方式。Width长度为一个基准(程序中的fact)的整数倍。 类似于坐电梯。...代码先上电梯,电梯容量为fact,等代码快上完,注释再上。代码上的时候发现没上满,就拿空格占位,空着也不让注释上。 2.指定Width(程序中的min)方式 相当于限额。...代码要先占前W个位置,人不够用空格占,都占完了,注释才能上来。 这样就会有个问题,代码如果超过W,位置不够用了怎么处理。 处理方式有, 2.1代码和注释都将就,都满了,就顺序上了。...建议fact和min都取4的整数倍,这样缩进之间的注释也比较有层次。 因为js不熟,所以代码基本是类C的风格,不太简洁。

    6210

    谈代码注释

    只要写代码,就会遇到代码注释的问题。在不同的公司,不同的项目组,不同的项目中,可能会有不同的注释标准。有些标准让我们感觉很受益,有些则让我们感觉很反感。...当时我们讨论代码注释该怎么写的问题,最终同事抛出这么一个观点:“我之前在X为干过,那儿就需要每行代码都写注释,所以我们应该执行这样的标准”。...因为我怀疑他之前可能在一家给X为干活的外包公司工作。也许X为的确有严格的代码注释量要求(也许“注释行数”/“代码行数”>0.5),于是这家外包公司就做了一个“任何一行代码都要写注释”的要求。...所以我会在自己的项目中,将这种注释都删掉。假如我们的代码要依靠神来保佑,我只能质疑你代码的质量是不是已经超神了。我们还是要信奉二进制的。...其次代码和注释应该是一个整体。往往一份文件包含代码和注释两部分,而阅读这份文件也有两个主体——编译器和人。编译器只是通过代码来获得逻辑信息,而人的要通过代码和注释一起理解逻辑和业务。

    94230

    Python 代码注释

    注释的作用 用自己熟悉的语言,在程序中对某些代码进行标注说明,增强程序的可读性。...单行注释 以 # 开头,# 右边的所有东西都被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用 示例代码如下: #!...,然后再编写相应的说明文字 在代码后面增加单行注释 在程序开发时,同样可以使用 # 在代码的后面(旁边)增加说明性的文字 但是,需要注意的是,为了保证代码的可读性,注释和代码之间 至少要有 两个空格 示例代码如下...注释不是越多越好,对于一目了然的代码,不需要添加注释 对于 复杂的操作,应该在操作开始前写上若干行注释 对于 不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)...绝不要描述代码,假设阅读代码的人比你更懂 Python,他只是不知道你的代码要做什么 养成写注释的习惯,让自己、让同事、让借鉴者有着更好的代码阅读体验。

    1.2K20

    10段奇葩的代码注释

    码个蛋(codeegg)第 609 次推文 程序员作为一种“异类”,虽然他们平时给人们的留下的印象并不太好,觉得他们只会写代码。...但是有的时候不得不佩服他们天马行空的想象力,他们可能会利用注释让你噗嗤一笑,下面我们来看看那些奇葩搞笑的代码注释吧。 1 能用代码注释画出这么形象的佛祖,看来真的是下了一番功夫。...最后留下的那首诗,简直就是程序员生活的真实写照。 ? 2 能用代码去注释这么多羊,写着写着就真的该睡着了 (~﹃~)~zZ ?...4 程序员的寿命只有五岁么?25岁以上都该等死啦?那我岂不是濒死状态了。 ? 5 这是有多闲才能在注释里写下那么多顶.顶.顶.顶.顶..... ?...6 这个注释写出的键盘,我服,忍不住都想去按下键盘。 ? 7 你以为有神兽保护,就不会写出bug了吗? ? 8 这个注释的小猪真的是很生动啊 ?

    54020

    代码注释中的常见标记

    FIXME 在代码注释中,FIXME 是一个常见的标记,用来指出代码中的一个问题需要被修复或需进一步的工作。...使用 FIXME 注释的原因可能包括: 代码存在已知的错误,但需要更多的调查或复杂的修复。 功能实现了,但可能不够稳健或有效,需要进一步的优化。...代码可能是临时的解决方案,需要被更完善或更合适的实现所替代。 开发者想要在稍后回顾这部分代码,进行重构或改进。 FIXME 标记通常会伴随一段描述,解释需要修复或关注的具体问题。...FIXME 类似于其他代码注释标记,如 TODO (表示还有工作要做)或 NOTE(用来强调或解释代码的某个方面),但 FIXME 更具有紧迫性,通常表示代码中存在更严重的问题或错误。...开发团队可能会有自己的注释标记约定,实际使用的标记取决于团队的偏好和工作流程。使用这些标记可以帮助团队成员快速定位代码中需要特别注意的部分。

    11110

    如何批量去除代码内的所有注释?Remove.exe批量去除代码注释

    写注释是一个非常好的习惯,但是某些情况下,我们又不想保留代码里的注释,于是就有了下面这个小软件(大小仅1.6m)。...点击此处下载:https://nicen.cn/collect/remove.exe Remove.exe 一个批量去除代码内所有注释的小工具,支持去除C家族系列的单行和多行注释,比如下面这种: /*...多行注释 */ // 单行注释 1.使用说明 双击运行exe文件,将会弹出如下的窗口界面: 启动 点击选择代码目录,选择需要去除注释的项目目录,之后会弹出第二个窗口,如下: 参数 选择需要排除的文件或目录...,然后输入需要移除注释的文件的格式类型,点击运行: 移除注释 耐心等待处理结束。...提醒 移除注释之前,记得备份一份带注释的源文件,代码无价,慎重操作

    1K20

    代码注释怎么写:打造优质代码的技巧

    在编程中,有一种无声的艺术,那就是代码注释。这可能看起来微不足道,但其实非常关键。它不仅有助于他人理解你的代码,也是自我表达的一种方式。为什么写注释?...在我们深入细节之前,先让我们探讨一下为什么写注释如此重要。增加可读性:好的注释能增加代码的可读性,让其他人更快理解你的代码逻辑。...协作:在 团队项目 中,注释是沟通的桥梁,能帮助团队成员理解代码的意图和实现方式。维护:在后期对代码进行修改或优化时,注释能帮助快速定位和理解代码段落的功能。...好的注释实践接下来,我们将探讨一些好的注释实践,展示示例代码,并讨论在不同技术场景下的应用。单行注释单行注释适用于简单说明一行代码的作用。...过度注释:注释应该是必要的,过多的注释会使代码变得难以阅读。过时的注释:随着代码的更新,确保相关注释也同步更新。含糊不清的注释:注释应明确清晰,避免引起更多的混淆。

    13410

    你见过哪些独特的代码注释

    作为开发者,或者说作为程序员,每天和代码打交道,那么自然也就需要代码注释。从程序员的角度来看,代码注释必不可少。好的代码注释不仅能帮助开发者更好地理解代码,还能提高代码的可读性和可维护性。...代码注释好的代码注释可以帮助其他开发者理解代码,这在团队协作中,无疑会大大的提高团队的整体效率。...同样的,通过注释,他们可以更快地了解你的代码是如何工作的,从而避免不必要的误解和错误,就像这样的注释代码注释还可以帮助程序员记录当时的业务需求,从而帮助程序员在排查业务问题时可以快速理解具体的业务逻辑,...利于业务需求的回溯定位,比如这样的注释代码注释也可以帮助记录处理问题的历程,比如这样的代码注释,详细记录了问题处理时间以及当时产生问题的订单号,方便快速定位问题独特的代码注释说到独特的代码注释,个人在工作中或者说在阅读源码的过程中确实没有遇到像大家提到的比较幽默或者说充满人生哲理这样的注释...独特的代码注释也算见过,在启动项目的时候,banner文件里面会有比较有意思的内容,就像这样的启发说到代码注释带来的启发,可以说好的代码注释确实很有用,可以帮助团队其他人快速理解相应的业务逻辑代码,提高工作效率

    19610

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

    错误注释 你的注释是不是这样的? //时间戳日期格式化函数 function formTime(time,isyear){ } 亦或者是这样的?.../* 时间戳日期格式化函数 */ function formTime(time,isyear){ } 简单的变量声明之类的内容可以进行简单注释,但是函数就不能这样做了,要知道注释的作用是一种为了让代码更易读...、易维护、易理解,起到提示的作用的,上面的两个注释都是正确的,但是它起到的作用太低了,在正式工作中我们往往会协同开发,这种注释是万万不可的。...正确注释 正确的注释 就是文档注释,先来看看是什么样子。...普通注释 文档注释 这种提示就像嵌代码在里面一样,而不是浮于表面了,在我们书写npm包的时候,用户使用我们的包,就能看到这种提示,对使用者特别友好。

    20920

    IDEA自动生成代码注释

    注释就是对代码的解释和说明。目的是为了让别人和自己很容易看懂,一看就知道这段代码是做什么用的。正确的程序注释一般包括序言性注释和功能性注释。序言性注释的主要内容包括模块的接口、数据的描述和模块的功能。...模块的功能性注释的主要内容包括程序段的功能、语句的功能和数据的状态。...*/ 5.勾选所有代码适用选项 6.点击EDIT VARIABLES并编辑,其中VAR1输入以下groovy脚本,并保存。.../**,然后在输入tab键,最后一路按下enter键 有一个关于程序员的段子,说所有的程序员都讨厌两件事,一是别人不写注释,二是自己写注释。...关于写注释,一直有人争论不休,有的人认为写代码必须要写注释,而又的人认为代码就是注释,何必再写一遍?希望本文可以对你有所帮助。

    7.2K20

    个性代码注释 大合集

    ━┓ * ┃      ┣┓ * ┃     ┏┛ * ┗┓┓┏━┳┓┏┛ * ┃┫┫ ┃┫┫ * ┗┻┛ ┗┻┛ * 神兽保佑 * 代码无...  ┃       ┃ *   ┗━┓   ┏━┛Code is far away from bug with the animal protecting *     ┃   ┃ 神兽保佑,代码无...┏━┛ *          ┃   ┃ Code is far away from bug with the animal protecting *          ┃   ┃ 神兽保佑,代码无...*         ┃   ┃    Code is far away from bug with the animal protecting *         ┃   ┃ +     神兽保佑,代码无...| | | ) __\ | | | | /__ (vvv(VVV)(VVV)vvv) */ Ref: 超有意思的程序代码注释

    2K20
    领券