注释之背后:代码的解释者与保护者

简介: 注释之背后:代码的解释者与保护者

注释之背后:代码的解释者与保护者


引言 作为一个编程不到一年的初学者来说,想借此机会说说我对 “代码是否写注释” 这个问题的一些看法.

在了解并学习java编程语言之后,我对"面向对象编程"这几个字愈加深刻也逐渐有了自己的理解,我们通过观察现实世界中存在的客体的属性和行为,抽象成一个个虚拟的对象,然后再将这些对象实例化,在计算机上利用这些实例化的对象对现实世界进行模拟,解决可能问题和实现功能.这就是我理解的面向对象编程。像面向对象编程一样,注释也应该成为你编写代码的一部分。那么你的注释是否应该同样是面向对象注释呢?

正如我们通过对象的属性和行为来理解现实世界一样,注释通过解释代码的属性和行为来帮助其他开发人员理解你的虚拟对象(即代码)。所以注释需要面向的对象有两个方面: 代码和读者。

因此,注释需要将代码和读者联系起来,那么它需要在这两者之间需要扮演这样的角色 :

  • 代码的解释者,有助于传达代码的背后意图和设计决策。
  • 代码的保护者,有助于减少风险、预防错误和提高代码的可维护性。

代码的解释者

有些人认为,代码本身应该是自解释的,也就是说,良好编写的代码应该清晰易懂,无需额外的注释。这是一种重要的观点,因为过度依赖注释可能意味着代码本身质量不高。**所以此时的注释应该用来解释为什么要这样做,而不是解释正在做什么。**这样你的代码依旧保持了优雅,而注释则会成为你代码的最佳拥护者。所以我们需要发挥自己的能力和思考让注释成为代码的优秀解释者。

学习编程的中我时常会遇到各种大大小小的难题,当我想要解决这些难题的时候,会上网查,看到有解决此类问题的博客,而很多优秀的博客中的编写的代码都有注释,很多时候我会因为一个好的注释而瞬间被点醒!


代码的保护者

注释就像是给你的代码贴上便签,提醒问题、解释意图,并指导修改,使代码更容易理解和维护。

你可以用注释来标记代码中可能有的问题或需要改进的地方,这帮助读者或者团队快速发现和修复错误,减少潜在风险。也可以指导其他人如何修改代码,以确保他们不会破坏现有功能。同时, 注释可以为代码提供上下文,使读者了解代码的特殊情况和约束条件。


总结

以上就是我对代码是否注释问题的看法,我始终认为真正优雅的代码,加上好的注释是锦上添花 !

目录
相关文章
|
4月前
|
设计模式 算法 前端开发
有什么可以减少注释,但依然能让他人看得懂代码的方法吗?
有什么可以减少注释,但依然能让他人看得懂代码的方法吗?
30 0
|
3月前
|
Java 程序员 C#
C# 介绍、应用领域、入门、语法、输出和注释详解
C#(发音为“C-Sharp”)是一种由 Microsoft 创建的面向对象的编程语言,运行在 .NET Framework 上。源于 C 家族,与流行的语言如 C++ 和 Java 相近。首个版本发布于 2002 年,而最新版本,C# 12,于 2023 年 11 月发布
68 0
|
6月前
|
人工智能 自然语言处理 Java
提高代码可读性的秘诀:注释的重要性
A:你写代码怎么连注释都不加? B:老大为什么要加注释? A:你不加注释,你怎么知道我能看懂你的代码? B:遇到问题你找到就可以了啊? A:那你哪天生病了请假了闹情绪了离职了,公司怎么办? B:我现在反正没觉得有什么问题,我对公司也很满意,安心啦! 又是00后整顿职场的一段精彩演绎。不可置否,在实际的软件开发过程中,确实有很多开发人员依然不愿意写注释认为这会浪费时间,或者自认为他们的代码足够清晰,不需要额外的解释。但这种想法too young too simple,代码注释对于项目的质量和效率有着深远的影响,在软件开发中的重要性不容小觑。
|
7月前
|
PHP 开发者
|
9月前
|
程序员
相见恨晚的Matlab编程小技巧(2)-代码怎么做到逻辑清晰?——巧用注释符“%“
        本文将以教程的形式详细介绍Matlab中两个常用符号“%”和“%%”的作用。初学者可以通过此文掌握这两个符号的用法,为Matlab编程打下坚实的基础。
|
11月前
|
NoSQL Java 数据库
解释afterPropertiesSet方法的用处
解释afterPropertiesSet方法的用处
编程基本功:做自解释的测试文档
编程基本功:做自解释的测试文档
47 0
编程基本功:做自解释的测试文档
|
Unix Apache C++
给代码写注释时有哪些讲究?
给代码写注释时有哪些讲究?
125 0
给代码写注释时有哪些讲究?
|
设计模式 自然语言处理 程序员
一场关于代码注释的争执,引发的三点思考
在一次研发沟通会上,大家关于是否需要代码注释做了一番争执(讨论)。
一场关于代码注释的争执,引发的三点思考