`
lijuanabc
  • 浏览: 124681 次
社区版块
存档分类
最新评论

养成写注释的好习惯

 
阅读更多

注释是很重要的,特别在一些大公司里,对于注释的要求特别高,看一个程序员的水平高低,一般看他的注释就能看出来,所以平常养成写注释的好习惯对应程序员来说是很重要的。一般注释和源代码的比例是1:1,甚至1:2或者1:3。


自己就有这种体会。别人发来代码要我修改,一看源代码那叫惨不忍睹,密密麻麻的一片,不见一个中文(当然写英文注释还是可以理解的)。修改起来这叫我痛不欲生啊!自己要里弄懂每个变量,每个语句是什么含义,这个代码块是什么作用,如此等等。反正我是受不了这种摧残,还不如叫我自己实现这个功能。所以写好代码的注释不仅是你受用,别人也会受益匪浅。


优美的代码是必须要有注释的。阅读注释详细、稳妥的代码是种享受,或许只有程序员才能体会其中的乐趣吧。


平时注意这个习惯,写好注释。一是因为别的程序员会使用你的程序,增加程序的可读性。别人使用起来方便,如果没有注释,别的程序员还不如自己重新写,这样效率或许会快些。二是自己以后也需要阅读,人的记忆不可能永远那么好,总有忘记的时候。所以写好注释可以让自己快速地明白当初自己写代码的含义,这样会事半功倍。


从现在开始,给代码写上注释吧,让自己走得更稳,更远。

分享到:
评论

相关推荐

    养成C_编程好习惯提高程序可读性_之注释篇

    总的来说,养成良好的编程习惯,尤其是注重注释的使用和格式,可以显著提高代码的可读性,降低维护成本,提升软件质量。对于初学者,这有助于更快地理解代码逻辑;对于教师和培训者,可以提高教学效果;对于项目管理...

    养成C++编程好习惯提高程序可读性_之注释篇

    ### 养成C++编程好习惯提高程序可读性_之注释篇 #### 引言 在软件开发过程中,良好的编程习惯对于提高程序的质量、维护性和可读性至关重要。对于C++这样的强类型语言来说,养成良好的编程习惯尤为重要。本文主要...

    初学者编程必须养成的十大好习惯

    初学者编程必须养成的十大好习惯,很实用的哦 1、设计规划 现在是模块化程序设计的天下,应用程序要实现的目标就是金字塔尖,进行程序设计规划的意义就在于,对构成金字塔的基础模块进行划分,规划得越详细,模块...

    写程序时编程十大好习惯

    根据题目提供的信息,“写程序时编程十大好习惯”这一主题提供了非常有价值的建议,下面将对这些好习惯进行详细解释。 ### 1. 明确目标与需求 在开始编写任何代码之前,明确项目的目标和需求至关重要。这不仅包括...

    几个写代码的好习惯,对写好代码很用帮助

    以下是一些有助于写出更好代码的习惯: 1. **保持代码整洁与一致性**:遵循统一的代码风格和格式,例如,缩进、空格和命名约定。每个函数或方法应保持单一职责,避免过长的代码块。当需要添加新功能时,先考虑如何...

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

    在自动化编程领域,TIA博途( Totally Integrated Automation Portal)是西门子提供的一款集成化工程软件,用于设计、编程和调试PLC(可...因此,在编写任何程序时,都应养成良好的注释习惯,以确保代码的清晰和规范。

    java初阶-注释

    作为一个刚接触的编程的人来说,写代码不仅要让自己看懂,也要让别人清楚明了的知道自己写了什么,因此要养成写注释的好习惯。注释分为三种:单行注释、多行注释以及文档注释。

    Java中给自己写的方法增加注释

    在Java编程中,注释是不可或缺的一部分,它不仅有助于提高代码的可读性,也有利于团队协作和后期的维护。...因此,我们应该养成编写清晰、准确的注释的习惯,尤其是对于我们自己编写的方法,注释的重要性不言而喻。

    Java的注释

    ### Java的注释 在Java开发中,良好的注释习惯对于提高代码的可读性和可维护性至关重要。本文将详细介绍几种常见的Java注释方式及其用途,并通过实例...希望每位开发者都能养成良好的注释习惯,让代码更加清晰易懂。

    学好vc养成十大好习惯

    4. 养成良好的文档习惯:文档是软件开发的重要组成部分,可以帮助保持项目组织清晰,避免后期维护时的困扰。编写设计文档和注释代码,可以确保遵循预设的设计思路,提高代码的可读性和可维护性。 5. 规范的代码风格...

    代码注释率,有效解决程序健壮性的问题

    在编程世界中,代码注释是开发者之间交流思想、解释代码功能的重要手段,也是保证程序健壮性的一个关键因素。代码注释率是指源代码中注释行数占...因此,每个开发者都应该养成良好的注释习惯,让代码更易于理解和维护。

    注释模板代码格式化

    在编程世界中,注释模板和代码格式化是提高代码可读性和团队协作效率的关键因素。良好的注释有助于理解代码的功能、逻辑和目的,而统一...因此,无论是个人项目还是团队开发,都应该重视并养成良好的注释和格式化习惯。

    eclipse的注释模板

    这个模板主要用于平时类,方法,属性等一些注释,可以养成更好的代码习惯

    html注释对div的影响

    HTML注释是网页开发中一个基础且重要的元素,它主要用于增加代码可读性,记录代码功能,或在调试过程中暂时屏蔽部分代码。...在实践中,我们应养成良好的编码习惯,让注释成为我们的好帮手,而非潜在的陷阱。

    myeclipse/eclipse设置java文档注释

    ### myEclipse/Eclipse 设置 Java 文档注释详解 #### 一、引言 在进行软件开发的过程中,良好的代码注释习惯对于提升代码可读性和维护性至关...希望每位开发者都能够养成良好的文档注释习惯,共同促进项目的健康发展。

    JAVA编程注释规范详解

    ### JAVA编程注释规范详解 #### 一、引言 注释是软件开发过程中不可或缺的部分,它能够帮助开发者更好地理解...通过本文介绍的Java编程注释规范,希望每位开发者都能养成优秀的注释习惯,编写出既优雅又实用的代码。

    使用简单的注释记录函数的所有作业和返回值

    在JavaScript开发过程中,良好的代码注释是至关重要的。它们不仅帮助开发者理解代码的功能,还能够记录...因此,无论是在个人项目还是团队协作中,都应该养成良好的注释习惯,确保每个函数都有清晰的作业和返回值记录。

    Android Studio kotlin生成编辑类注释代码

    更新了AS 3.1.2之后,发现新建Kotlin类,类注释依然木有,没办法只有自己动手了。...相信大家刚开始写代码的时候就被前辈告知了要养成写注释的好习惯,今天我们来了解一下如何利用我们平时写的注释生成文档,一起

    1.java注释.zip

    Java注释是编程过程中的重要组成部分,它有助于提高代码的可读性和可维护性。本文将深入探讨Java注释的类型、使用方法以及其在软件开发中...因此,在编程过程中,我们应该养成良好的注释习惯,使代码更易于理解和维护。

Global site tag (gtag.js) - Google Analytics