`
izuoyan
  • 浏览: 9293370 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

你为什么不写注释?

 
阅读更多

Coding的时候,你喜欢写注释吗?

我说,写好注释便是完成了一半的代码功能。

注释,标注关键、简要解释。这是我的理解,这段时间做Yh的后期更新,看了一些写的很“干净”的代码。看了一段时间,脑子便和代码一样“干净”了很多。

能够清晰简洁的写好注释,那么注释之外便是万事升平。良好的代码注释习惯也是一个软件开发人员的必备专业素质之一,如果我们无法对自己的实现进行清晰概括,那么这个实现肯定也是一塌糊涂的。写注释没必要面面俱到,那样岂不是成了(真伪代码)的双重实现。简明扼要,可以作为编写注释的一种标准。简单明了的对关键字段进行概要说明这便是我对注释的一种理解标准。

其实,写不好注释照样能成为好的开发者,若只想要天朝V5,只知道夜郎自大,那样也没必要写注释之类,不予外交,便也谈不上交流沟通了。

其实,写注释,很简单。这个过渡也可是前进一小步,进步一大步。

分享到:
评论

相关推荐

    代码中到底应不应当写注释?

    以下是对标题《代码中到底应不应当写注释?》所涉及知识点的详细阐述: 首先,注释的作用和重要性。注释应该解释代码为什么以某种方式实现,而不是解释代码本身在做什么,因为代码的逻辑应当是自解释的。一个良好的...

    java的注释规范(单行注释、多行注释、分块注释)

    java 注释规范是 Java 开发过程中不可或缺的一部分,它的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。java 注释规范可以分为三种:单行注释、多行注释和分块注释...

    svn强制写注释才能提交代码

    svn强制写注释才能提交代码 不写注释就报错 并且提交不成功

    什么时候应该避免写代码注释?

    然而,"什么时候应该避免写代码注释?" 这个问题提出了一个反常规的观点。虽然注释在大多数情况下是有益的,但过度依赖注释或者用注释掩盖糟糕的代码结构,可能反而带来负面影响。 首先,"不要注释坏代码——重写吧...

    NSGA-III算法-matlab版本-写满了中文注释

    因为也没有完全弄懂代码,所以有些地方空着没写注释,有些地方还注释了问号。就是希望能和大家一起讨论交流一下,希望大家指正。希望弄懂代码的小伙伴能回帖说一下自己的理解。也希望能解答一下我不懂的地方。  ...

    C#源码。对INI的读写操作、有注释

    在IT行业中,C#是一种广泛使用的编程语言,尤其在开发Windows桌面应用和.NET框架相关项目时。...如果你对INI文件的操作不熟悉,这个代码实例将是一个很好的学习起点,如果有任何疑问,可以通过留言获取更多的帮助。

    注释代码的13条注意事项

    代码注释的13条注意事项 作为一名IT专业人士,我将对代码注释的13条注意事项进行详细的解释和分析。 1. Comment each level(每个级别的注释...写注释时,应该假设你在写给自己,以便于你自己在将来更容易理解代码。

    C++注释转换为C语言的注释

    在Windows 下用VC2005环境写程序的时候, 有C语言写的程序, 但是用了C++的注释, 也能成功编译连接运行. 但发现也有很多编译器不支持C++的单行注释. 又不想手机地改所有的代码. 所以写了一个程序来自动将C++的单行注释...

    Python中注释(多行注释和单行注释)的用法实例

    例如,开发者可以在需要注释的代码上方或旁边写上注释来说明该段代码的功能。单行注释能够帮助其他阅读代码的人快速理解代码的作用和目的,是提高代码可读性的有效手段。 多行注释则允许开发者一次性注释掉多行代码...

    源文件注释清理器(C#写的)

    标题中的“源文件注释清理器(C#写的)”指的是一个使用C#编程语言开发的工具,它的主要功能是清理源代码文件中的注释。在软件开发过程中,注释是用来解释代码功能、逻辑或提高代码可读性的文本,但在某些场景下,如...

    c#文档注释规范

    ### C#文档注释规范详解 #### 一、引言 C#作为一种广泛使用的编程语言,不仅因其简洁高效的语法而受到开发者的喜爱,更重要的是它有一套完整的文档注释规范,帮助开发者更好地理解和维护代码。本文将深入探讨C#中...

    怎么在.js文件里写中文注释

    4. **文档化**:除了代码中的注释外,还应该提供详细的文档,以便于其他开发者或用户理解和使用你的代码。 #### 总结 在 `.js` 文件中使用中文进行注释是一项基本但重要的技能。通过选择合适的字符编码、遵循良好...

    批量删除C和C++注释

    在编程过程中,注释是必不可少的部分,它们有助于代码的可读性和团队间的沟通。然而,在某些特定场景下,比如代码混淆、性能优化或者自动化测试时,可能会需要批量删除C/C++源码中的注释。本篇文章将详细讲解如何...

    Java注释规范

    6. 对代码的注释应放在其上方相邻位置,不可放在下面。 7. 变量、常量的注释应放在其上方相邻位置或右方。 8. 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明...

    JAVA中如何写注释ji

    多行注释通常用在单行放不开了,需要写在多行时使用。 生成文档注释 生成文档注释用于自动地生成文档,一般用在方法或类上方,进行方法说明或者类说明。使用/和*/括起来。例如: ``` / * 这是一条生成文档注释 ...

    TIA博途中添加程序注释的具体方法示例-汇总.docx

    首先,我们可以为变量添加注释。在PLC变量表中,每创建一个新的变量,最后一栏通常会有一个注释字段。你可以在此处输入关于变量功能、用途或值范围的描述。对于存储在数据块(DB)中的变量,同样可以在其注释栏中添加...

    Dreamweaver怎么给代码添加注释?

    例如,你可以写“这是一个示例注释,用于解释这段代码的作用”。 7. 输入完注释后,按回车键,Dreamweaver会自动为你添加注释结束的符号“-->”,这样就完成了一个完整的HTML注释的插入。 对于CSS和JavaScript代码...

    手写数字识别OCR数据集以及识别代码附有详细注释

    总的来说,这个数据集和代码为学习和实践手写数字识别提供了一个理想的起点。通过深入研究和实验,你可以掌握深度学习的基本原理,以及如何利用这些知识解决实际问题。无论是对计算机视觉领域感兴趣,还是想要提升...

    基于python写的春节烟花源码+注释.zip

    基于python写的春节烟花源码+注释.zip基于python写的春节烟花源码+注释.zip基于python写的春节烟花源码+注释.zip基于python写的春节烟花源码+注释.zip基于python写的春节烟花源码+注释.zip基于python写的春节烟花...

    删除源程序中的注释

    它们不参与程序的执行,但对理解代码逻辑至关重要。然而,在某些特定情况下,如优化代码大小、保护知识产权或者创建混淆版本时,可能会有需求删除源程序中的注释。本文将深入探讨删除源代码注释的原理、方法以及可能...

Global site tag (gtag.js) - Google Analytics