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

养成写注释的好习惯

 
阅读更多

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


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


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


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


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

分享到:
评论

相关推荐

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

    养成良好的编程习惯对软件的开发维护与再开发至关重要 本文根据作者多年软件开发的经验针对初中级 语言程序员 和初涉 语言的有经验的 语言程序员 从自学 教学 软件开发的角度阐述并列举了提高程序代码可读性的一些...

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

    养成良好的编程习惯对软件的开发、维护与再开发至关重要。本文根据作者多年软件开发的经验,针对初、中级C++语言程序员和初涉C++语言的有经验的C语言程序员,从自学、教学、软件开发的角度阐述并列举了提高程序代码...

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

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

    java初阶-注释

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

    Java的注释

    Java注释的良好习惯,方便项目的交接和事后的维护与整理,是一个很好的帮助自己养成编码习惯的工具,效果图在我的博文有记录,有需要的伙伴可以自行下载哦~

    eclipse的注释模板

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

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

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

    Java注释规范整理.docx

    在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为...长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力。

    Myeclipse的的注释文档codetemplates和eclipse-formatter

    JAVA初学者必备注释文档帮助你养成好的习惯

    C++入门到精通

    三、一定要养成写注释的习惯,特别是你的代码要给别人看时。 四、遇到问题,一定不要立刻问别人,其实很多问题都是自己不小心所致,回头看看书你可能会明白原来这也很简单。 五、多看看头文件中的内容,它能告诉你...

    Java规范开发手册.pdf

    我们从现在开始就要养成好的代码规范习惯。在日常的写代码中就要注意写注释、命名方面、格式方面都要规范化。使得写出的代码做到你懂他也懂。因为代码不是一个人看的,团队合作中你要把你写的方面的代码使别人能够...

    笨办法零基础学 Python 中文第三版

    本书区别于其它入门书籍的特点如下: • 注重实践。本书提供了足够的练习代码,如果你完成了...• 注重好习惯的养成。本书详细地讲解了怎样写出好的代码、好的注释、好的项目。这会让你在后续的学习中少走很多弯路。

    安卓毕业设计app项目源码-streak-counter:Android应用程序通过鼓励您保持连续记录来帮助您养成习惯

    和数据绑定,如果你有更好的实现,代码写得尽可能干净,创建一个拉取请求。 帮助发展这个项目。 您可以在代码中找到TODO和FIXME注释作为起点。 我们遵循分行管理。 贡献 代码 如果您是开发人员并且希望为该应用程序...

    《笨方法学Python》

    《笨方法学Python》:笨办法学 Python》(Learn Python The Hard Way,简称 LPTHW)是 Zed Shaw ...• 注重好习惯的养成。本书详细地讲解了怎样写出好的代码、好的注释、好的项目。这会让你在后 续的学习中少走很多弯路。

    软件研究室培训(编程规范)

    如果你在开始写代码时就关心风格问题,如果你花时间去审视和改进它,你将会逐渐养成一种好的编程习惯。一旦这种习惯变成自动的东西,你的潜意识就会帮你照料许多细节问题,甚至你在工作压力下写出的代码也会更好。

    中兴通讯编程规范(正式版)

    如果你在开始写代码时就关心风格问题,如果你花时间去审视和改进它,你将会逐渐养成一种好的编程习惯。一旦这种习惯变成自动的东西,你的潜意识就会帮你照料许多细节问题,甚至你在工作压力下写出的代码也会更好。

    Java高级程序设计实战教程第一章-Java编码规范.pptx

    一、规范的代码可以促进团队合作 二、规范的代码可以减少bug处理 三、规范的代码可以降低维护成本 四、规范的代码有助于代码审查 五、养成代码规范的习惯,有助于程序员自身的成长 Java高级程序设计实战教程第一章-...

    八年级上册信息技术-4课-初识python教案.docx

    在调试程序过程中养成耐心细致的好习惯。 教学重点 1. 学会在Python交互模式下使用print()函数。 2. 掌握Python程序的新建、设计、保存、运行的一般流程,并熟悉注释的使用方法。 教学难点 掌握Python程序的新建、...

    mo-ikai:一个iOS应用程序,可通过提供有意义的统计数据和对一致性的见解来帮助养成良好的习惯和消除不良的习惯

    魔界这个程序是为想要建立一致的好习惯并改掉坏习惯的人而设计的。 用户每天输入数据来跟踪其习惯,并且该应用程序会提供有意义的统计数据和有关其进度的见解,例如一致性百分比,努力程度,娱乐程度,图片,视频,...

Global site tag (gtag.js) - Google Analytics