`
gaofen100
  • 浏览: 1227714 次
文章分类
社区版块
存档分类
最新评论

10个最“优秀”的代码注释

 
阅读更多

下面是stackoverflow网站上网友针对你看到过的最好的代码注释是什么样的?这个问题给出的回答的前10条:

1.

// 亲爱的维护者:

// 如果你尝试了对这段程序进行‘优化’,

// 并认识到这种企图是大错特错,请增加

// 下面这个计数器的个数,用来对后来人进行警告:

// 浪费在这里的总时间 = 39h

2.

/** * 致终于来到这里的勇敢的人:

你是被上帝选中的人,英勇的、不辞劳苦的、不眠不修的来修改

我们这最棘手的代码的编程骑士。你,我们的救世主,人中之龙,

我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己。

永远不要哭啼,永远不要说再见。永远不要说谎来伤害自己。 */ 

3.

Exception up = new Exception("Something is really wrong."); throw up;  

4.

// 一些修改1 - 2002/6/7 增加临时的跟踪登录界面

// 一些修改2 - 2007/5/22 我临时的犯傻 

5.

 #define TRUE FALSE //逗一逗调试程序的傻瓜们

6.

if (/*you*/ $_GET['action']) { //celebrate(恭喜)

7.

// 如果这段代码好用,那它是Paul DiLascia写的。

//如果不好用,我不知道是谁写的。 

8.

//写这段代码的时候,只有上帝和我知道它是干嘛的

//现在,只有上帝知道 

9.

 // 晕了,以后再修改

10.

 // 神奇。勿动。

你有没有更绝的?

0
4
分享到:
评论

相关推荐

    Android-BeautifulNotes-优美的代码注释

    总之,"Android-BeautifulNotes-优美的代码注释"项目关注的是如何通过注释提升代码的可读性和可维护性,这对于任何Android开发者来说都是一个宝贵的资源。通过学习和实践其中的原则和技巧,我们可以使自己的代码更加...

    ssm整合源代码框架,内附注释

    MyBatis则是一个优秀的持久层框架,它简化了Java与数据库的交互,避免了繁琐的JDBC代码。MyBatis支持XML或注解方式配置SQL语句,将SQL与Java代码分离,使得数据库操作更加清晰。同时,MyBatis的动态SQL功能强大,...

    优秀程序员的十个习惯

    【优秀程序员的十个习惯】 1. 持续学习与跟进新技术:作为优秀程序员,保持对新知识的渴望至关重要。不断学习新的编程语言、框架和工具,关注行业动态,参与专业社区讨论,如CSDN、ITPUB、CHINAUNIX、digg.com等,...

    一个优秀的程序员的十个习惯

    7. **注重文档编写**:编写清晰的代码注释和文档是优秀程序员的重要习惯。文档不仅是自我记录,也是团队间的知识传递,有助于提高团队效率和项目的可维护性。 除此之外,还有其他几个关键习惯: 8. **测试驱动开发...

    基于Matlab遗传算法求解函数优化问题源码+代码注释+项目说明.zip

    基于Matlab遗传算法求解函数优化问题源码+代码注释+项目说明.zip 【资源介绍】 该项目是个人课程作业,答辩评审分达到95分,代码都经过调试测试,确保可以运行!欢迎下载使用,可用于小白学习、进阶。 该资源主要...

    Flutter默认项目代码详解,注释超详细

    本篇文章将详细解析一个Flutter项目的默认代码结构,并提供丰富的注释,帮助开发者深入理解Flutter的开发环境和工作流程。 ### 1. Flutter项目目录结构 在Flutter项目中,主要包含以下几个关键目录: - `lib`:这...

    软著代码整理工具,可以实现一键提取文件中的代码并且自动删去空行和注释,便于进行软著申请

    一个优秀的软著代码整理工具会保证用户数据的安全,不保存或传输用户的源代码,确保个人隐私和商业机密得到尊重。 8. **版本控制与更新**:随着技术的发展,工具也需要不断更新以支持新的编程语言和格式。定期的...

    采用遗传算法求解最优化问题matlab.rar

    遗传算法是一种模拟自然界物种进化过程的优化方法,广泛...代码注释详细,使得用户可以理解每一步的操作,并根据实际问题进行调整和移植。如果你需要解决特定的最优化问题,可以基于这些函数进行修改,以适应你的需求。

    写好代码的十个秘诀——一个编程高手的新的体会!

    以下是从标题、描述和部分内容中提取的关于如何编写一流代码的十个秘诀: 1. **鲁棒性**:代码应坚固且稳定,能够处理异常情况,比如在示例代码中,当`CrntQtr`等于0时可能导致崩溃,应当添加适当的边界检查来确保...

    编写Ruby代码注释时需要注意的一些问题

    在Ruby编程语言中,良好的代码注释是提升代码可读性和团队协作效率的关键。下面将详细阐述编写Ruby代码注释时应注意的一些要点: 1. **自解释文档代码**:尽可能地编写清晰、简洁的代码,使得即使没有注释,其他...

    JAVA编程注释规范详解

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

    蓝桥杯第十四届省赛代码

    第十四届蓝桥杯省赛代码是参赛者们展示技能的重要平台,通过这样的比赛,选手们可以提升对编程语言的理解,熟练掌握常用函数的应用,并锻炼实际问题解决能力。 在描述中提到的"有备注版本",意味着代码中包含了注释...

    如何成为一个优秀的JSP程序员

    8. **最佳实践** - 遵循良好的编程习惯,如代码注释、模块化设计、避免在JSP页面中编写大量业务逻辑。 9. **性能优化** - 学习如何优化JSP页面,如减少HTTP请求、缓存策略、有效的数据传输方式等。 10. **版本控制...

    写好代码的十个原则

    "写好代码的十个原则"提供了指导开发者提升编程水平的关键点。以下是对这些原则的详细解释: 1. **鲁棒性(Solid and Robust)**:代码应具备抵御异常情况的能力,比如处理无效输入或系统故障。确保在出现预期之外...

    优秀的PHP程序员至少应该了解PHP代码的优缺点

    10. 代码审查:愿意参与和接受代码审查,通过同行评审提高代码质量。 11. 项目管理和团队协作:具备良好的沟通能力和团队协作精神,能够在项目中扮演积极的角色,与设计师、项目经理和其他开发人员有效配合。 12. ...

    林斌博士写好代码的十个秘诀

    林斌博士是微软中国研究院的开发经理,他分享了写好代码的十个秘诀,这些秘诀对于提高代码质量、可维护性和可读性至关重要。以下是这十个秘诀的详细解析: 1. **鲁棒性(Solid and Robust Code)**:编写能够处理...

    华为软件精英挑战赛决赛最优美代码奖.zip

    10. **文档与注释**:清晰的代码注释和文档,有助于他人理解和复用代码。 总之,"华为软件精英挑战赛决赛最优美代码奖.zip"的压缩包可能蕴含了众多软件开发的最佳实践和创新思路,对于参赛者和学习者来说,分析这些...

    写好代码的十个秘诀 的ppt

    10. **注释与文档**:添加必要的注释以解释代码的功能和逻辑,特别是复杂部分。良好的文档可以帮助其他开发者更快地理解和维护代码。 11. **代码布局**:代码的格式和排列应整洁一致,这有助于阅读和理解。使用空行...

    微软写好代码的10个秘诀

    微软作为全球领先的软件公司,对编写优秀代码有着深入的理解和实践。"微软写好代码的10个秘诀"这一主题,旨在分享提升代码质量的实用策略。以下是这10个秘诀的详细解析: 1. **清晰的代码结构**:良好的代码结构有...

Global site tag (gtag.js) - Google Analytics