`
朱秋旭
  • 浏览: 231019 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

重构代码之3-注释

阅读更多

写这篇博客的时候就在想,如果写注释会不会影响代码的质量呢?会不会影响自己对代码的仔细斟酌不知道,但是可以肯定的一点是,就算你写了注释肯定不会为你糟糕的代码加分的。所以就我个人而言我是不太喜欢写注释的。

凡事无绝对,有些注释是必须存在在那里的,比如法律信息;某个抽象方法返回值的解释;解释接下来的意图,让读者了解你想要干什么;为某个返回值阐述用途(看过前几篇博客的同学可能会说,不是要让参数和返回值自身能够说清楚吗?)其实有的时候可能你手头的代码是某个标准库的一部分,或者它是不能被修改的,这个时候你需要注释来帮助你记忆和理解;测试代码,警告(比如说:以下的代码不要运行,除非你有大量的时候去kill掉启动的那些线程),Todo代码,Javadoc。这些例子中出现注释总归会好一点,让人清晰且舒服。

同样凡事无绝对,有些地方还是别写注释的好,举个tomcat的例子:


我就不理解了,变量名已经清晰到极致了,干嘛要搞出个注释呢,实在没有意义啊

误导性的注释千万不要写,如果你知道自己不会维护也千万不要写,不然就会出现代码改了千万手了,注释还是beta版本的。还有就是想上面的例子,这种废话注释就不要写了,日志里面不要写注释,写好你的业务节点就好了,有些人还习惯做位置标记 比如://///////////////********////////////////, 其实就是一点,能用函数名,变量名说明的问题就不要去写注释,不写注释真的会提高你的代码能力。

不得不提的一个 就是有很多人喜欢注释代码,个人觉得代码有用就留着,没用就删除,您留这个注释的代码干嘛啊?如果我有幸维护您的代码,你说我是删除这个段代码还是留着? 用膝盖想我也不可能删除吧,留着大面积注释的代码,真是头疼。

 

特别提醒一下效率优化的开发者,如果代码中用到了算法,这个是一定要写好注释去解释说明的,可以是算法名,如果算法是你自己发明的那就一定要写清楚这个算法,或者写清楚如何使用,降低调用者的阅读成本。

 

ok,就写到这里吧,中秋快乐,吃了月饼重构代码吧哈哈哈。
 

  • 大小: 11.4 KB
2
0
分享到:
评论
2 楼 mfkvfn 2014-09-09  
有svn或cvs或git之类的代码管理工具,代码是不会丢掉的。历史记录里全都有。
1 楼 ArthurTsang 2014-09-09  
现在刚工作,改别人的代码的时候都是把原来的注释掉,再添加上自己的,就怕一不小心改错了,要弄回原来的很麻烦

相关推荐

    重构源代码C1-c++版本

    9. **注释与文档**:重构过程中,良好的注释可以帮助理解代码意图。可以添加或更新注释,以解释代码的功能和设计决策。 10. **性能优化**:虽然重构主要是为了提高代码质量,但有时也可能涉及性能优化。例如,通过...

    《重构》----学习笔记

    《重构》是一本深入探讨软件开发过程中的代码优化与改进的经典著作。重构,简单来说,是在不改变软件外部行为的前提下,对其内部结构进行改进,以提高代码的可读性、可维护性和可扩展性。这一过程并非依赖于个人天赋...

    重构代码参考文档

    本文档主要介绍了在重构代码过程中的一些关键技术和策略,适用于Java开发人员。首先,重构的目标是为了优化代码结构,提高可维护性和可读性。文档提到了几个核心的重构步骤和相关技术点。 1. **项目结构调整**: -...

    代码之美---精选版

    《代码之美---精选版》是一本深受欢迎的编程技术书籍,它汇集了众多编程实践中的智慧结晶,旨在帮助程序员提升代码质量,实现更优雅、更高效的编程。这本书以高清晰的PDF格式呈现,使得读者在学习过程中能享受到更好...

    重构 改善既有代码的设计 中文高清完整版pdf

    - 更新文档和注释,保持代码的一致性和可维护性。 - 持续监控代码质量,定期进行重构以应对需求变化和技术进步。 #### 结论 《重构:改善既有代码的设计》是一本非常实用且有价值的书籍,它不仅适合于初级开发者...

    重构-改善既有代码的设计

    重构是软件开发过程中一个至关重要的环节,它旨在不改变代码外在行为的前提下,改进代码结构,使之更易理解和修改。此书深入浅出地介绍了重构的概念、原则和实践方法,对于任何Java开发者来说,都是提升编码技艺的...

    代码大全--代码之美

    《代码大全--代码之美》是一本专注于编程实践与代码质量的经典著作,它深入探讨了如何编写出高效、可读性强、易于维护的代码。在软件工程领域,编写优秀的代码是提升项目质量和开发效率的关键。以下是对这本书所...

    一次代码重构之旅-快速读写xml文件工具类封装

    7. **最佳实践**:为了提高代码的可维护性,作者可能会采用一些最佳实践,如代码注释、合理的命名、遵循编程规范等。 在压缩包中的`LKDemo`文件可能是作者提供的示例代码或测试用例,用于演示如何使用这个工具类。...

    利用二阶锥实现的配电网最优潮流和重构matlab源码+详细注释.zip

    利用二阶锥实现的配电网最优潮流和重构matlab源码+详细注释.zip利用二阶锥实现的配电网最优潮流和重构matlab源码+详细注释.zip利用二阶锥实现的配电网最优潮流和重构matlab源码+详细注释.zip利用二阶锥实现的配电网...

    重构_改善既有代码的设计.pdf

    总之,《重构——改善既有代码的设计》不仅是一本对于Java程序员来说非常重要的参考书,也是所有软件开发人员都应该掌握的关键技能之一。通过不断地练习和实践,开发者可以逐步提升自己的重构能力,从而写出更加高...

    代码重构-以贪吃蛇为示例(四)-继续封装

    6. **代码注释与文档**:重构后,为了保持代码的可读性,作者可能会添加或更新注释,解释各个函数和类的作用,以及它们之间的关系。 7. **测试驱动开发(TDD)**:在重构过程中,可能会采用TDD方法,先编写测试用例,...

    重构java代码简洁之道

    9. **代码注释**:适当的注释可以帮助理解代码的目的和工作方式,但应避免过度注释,良好的代码结构本身应该足够清晰。 10. **代码审查**:通过同行评审,团队成员可以互相学习,发现并修复潜在问题,共同提升代码...

    代码之美-精选版 [文字版]中文.PDF

    《代码之美-精选版》是一本专注于代码优化的书籍,以中文形式呈现,提供的是文字版而非扫描版,因此读者可以方便地搜索、复制和粘贴其中的内容。这本书旨在帮助开发者提升代码质量,提高程序运行效率,降低维护成本...

    重构-改善既有代码质量

    《重构-改善既有代码质量》一书是Martin Fowler的经典之作,它深入探讨了如何通过重构技术来提升软件的可读性、可维护性和整体质量。重构是一个系统化的过程,旨在改进代码结构,而不改变其外在行为。在这个过程中,...

    重构-改善即有代码的设计

    马丁·福勒的《重构-改善既有代码的设计》作为一本经典之作,深入浅出地介绍了重构的原理、技术和实践案例,为程序员提供了一份宝贵的指南。 《重构-改善既有代码的设计》是软件工程领域中的一本重要书籍,尤其在C/...

    C++代码统计工具,可以统计C代码,行数,注释!

    3. **代码密度计算**:通过总行数减去注释行和空行得到有效代码行,然后用有效代码行除以总行数得到代码密度,以此评估代码质量。 4. **趋势分析**:记录每次统计的结果,形成历史数据,以便观察代码结构随时间的...

Global site tag (gtag.js) - Google Analytics