`
zhangfeilo
  • 浏览: 399103 次
  • 性别: Icon_minigender_1
  • 来自: 昆明
社区版块
存档分类
最新评论

代码审查最佳实践

阅读更多

代码审查可以帮助提高代码质量,避免由于代码习惯而造成的 bug。下面列出的这些要点因该可以作为大部分代码审查的指导,如果是 Java 应用的话,这些建议应该被视作最佳实践。

文档
1. Javadoc 应该在每一个类和方法中添加。
2. 如果是修复某个 bug,应该添加 bug ID。
3. 走捷径的方法或者复杂的逻辑要有解释。
4. 如果代码会被公开,每个文件头都要标注版权信息。
5. 复杂的 HTML,JavaScript,CSS 应该包含文档。

功能
1. 如果类似的逻辑被使用了多次,应该把它写成一个帮助类,然后在多出调用。
2. 鼓励使用 API 而不是重复编写代码解决相同的问题。
3. 要强调代码的单元测试。
4. 任何新加的代码不应该破坏已有的代码。
5. 假如是 Web 应用,JSP 不应该包含 Java 代码。

安全
1. 任何代码都不能执行用户的输入,除非转义过了。这个常常包含 JavaScript 的 eval 函数和 SQL 语句。
2. 禁止那些在短时间内提交非常多请求的 IP。
3. 任何类,变量,还有方法都应该有正确的访问域。
4. 尽量避免使用 iframe。

性能
1. 所有数据库和文件操句柄在不需要的时候都应该被关闭。
2. SQL 语句的写法会导致性能千差万别。
3. 鼓励创建不可变(immutable)的类。
4. 类似的逻辑代码,尽量通过 if else 语句来实现更多的重用。
5. 尽量避免使用重对象(heavy objects)。
6. 如果是 Web 项目,请检查是否使用了合适的图片尺寸,CSS sprites 和浏览器缓存等技术。
7. 全局都需要的信息保存在 application context 中。

编码习惯
1. 没有被使用的变量要删除。
2. 针对不同的 Exception 要用不同的 catch 语句,而不是一个 Exception 解决所有问题。
3. 针对变量,方法和类要用相同的命名方法。
4. 常量应该被写在独立的常量类中。
5. 每行代码的尾部不要有多余的空格。
6. 对于括号,循环,if语句等等要用统一的格式。
7. 每一个单独的方法不应该超过100行。
8. 一个单独的语句不应该超过编辑器的可视区域,它可以被拆分成几行。
9. 检查 String 对象既不是null也不是空的最好方法是 if(“”.equals(str))
10. 假如类有很多成员变量,并且实例化的时候只需要少数变量传入的话,最好使用静态工厂方法,而不是重载构造函数。
11. 给方法添加适当的访问控制,而不是所有都是 public。
12. 遵守项目中使用的框架的最佳实践建议,例如 Spring,Struts,Hibernate,jQuery。

以上的某些注意点可以通过静态代码检查工具完成,例如 CheckStyle,FindBugs 和 JTest。

0
3
分享到:
评论

相关推荐

    代码审查CodeReview的最佳实践

    我一直认为CodeReview(代码审查)是软件开发中的最佳实践之一,可以有效提高整体代码质量,及时发现代码中可能存在的问题。包括像Google、微软这些公司,CodeReview都是基本要求,代 我一直认为CodeReview(代码...

    代码审查表和代码审查实例

    代码审查是软件开发过程中的重要环节,它有助于提高代码质量,发现潜在的错误,以及确保遵循最佳实践。在Java编程中,代码审查同样至关重要,因为Java作为一种广泛应用的面向对象语言,其复杂性和广泛性需要严谨的...

    软件工程中的代码审查与质量保证.pptx

    #### 第四章:代码审查最佳实践 - **准备阶段**:明确代码审查的目标、选择合适的工具、编写清晰的文档。 - **审查过程**: - **代码规范**:遵循一致的代码风格指南。 - **同行评审**:鼓励团队成员之间的相互...

    presentation-CRADE:挑战代码审查最佳实践的研讨会 [SudWeb 2013]

    “CRADE”可能是“Code Review And Development Environment”的缩写,这是一个针对代码审查和开发环境的研讨会,特别关注如何挑战现有的最佳实践。这个活动在"SudWeb 2013"举行,这可能是一个技术会议或者开发者...

    Git:代码审查与Git最佳实践.docx

    Git:代码审查与Git最佳实践.docx

    火爆,Github标星240K的编程学习路线图,适合所有程序员!

    推荐一个涵盖开发、运维、产品设计的学习路线图,在Github已经start超过240K,包括各门编程语言! 该项目涵盖了非常全面的学习路线图: ...代码审查最佳实践 前端性能最佳实践 API 安全最佳实践 AWS 最佳实践

    Best Practices For Peer CodeReview

    ### 同行代码审查最佳实践 #### 引言 在软件开发过程中,同行代码审查(Peer Code Review)是一项被广泛采用的关键活动。它不仅能够帮助识别潜在的缺陷、提高代码质量,还能促进团队间的协作与知识共享。然而,...

    静态测试方法之代码审查(CodeReview)的清单

    下面列出的这些要点因该可以作为大部分代码审查的指导,如果是Java应用的话,这些建议应该被视作最佳实践。  代码审查可以帮助提高代码质量,避免由于代码习惯而造成的bug。下面列出的这些要点因该可以作为大部分...

    Best Practise for Peer Code Review

    ### 同行代码审查最佳实践 #### 概述 代码审查是软件开发过程中不可或缺的一环,它能够帮助团队发现潜在的缺陷、提高代码质量并促进团队成员之间的协作与学习。同行代码审查作为软件工程中的一个关键环节,对于...

    Java代码审查工具

    Java代码审查工具是提高软件质量和团队协作效率的重要手段。代码评审是一种系统性的源代码检查过程,旨在确保...定期进行代码审查,结合持续的教育和最佳实践分享,可以帮助团队保持代码的高质量,降低后期维护成本。

    软件工程中的代码审查实践与经验.pptx

    ### 软件工程中的代码审查实践与经验 #### 第一章:软件工程概述 - **定义**:软件工程是一种采用系统化、规范化且可度量的方法来开发和维护软件的学科。 - **目标**: - 提升软件质量 - 增加生产效率 - 降低...

    淘宝编码最佳实践 编码规范

    8. **代码审查**:鼓励团队成员之间进行代码审查,以发现潜在问题,分享知识,提升整体代码质量。 9. **性能优化**:在编码阶段就应考虑到性能问题,避免不必要的计算,优化数据结构和算法,合理利用缓存,减少IO...

    java代码审查.pdf

    中的知识点之前,需要明确这两个字段提供的是文件名和文件内容的描述,它们分别指出了文档的主题是关于Java代码审查的PDF文档,以及文档内容涉及到了Java编程语言中的代码审查技巧、bug修复、代码风格、最佳实践等...

    ASP.NET项目开发全程实录第3版(附带代码)

    10. **代码管理与团队协作**:介绍版本控制工具(如Git),以及团队开发中的协作和代码审查最佳实践。 通过本书的实录项目,读者将有机会实践上述知识点,从创建基本页面到构建复杂业务逻辑,逐步提升ASP.NET开发...

    Best practices in code inspection for safety-critical software

    ### 安全关键软件代码审查最佳实践 在当今数字化时代,计算机系统越来越多地监督和控制安全关键系统,逐渐取代了传统的故障安全硬件技术。这些系统不仅关乎财产与环境的安全,更重要的是保障个体的生命安全。然而,...

    修改软件的艺术:构建易维护代码的9条最佳实践

    代码审查也是传播最佳实践和团队知识的重要手段。 9. 持续重构:随着项目发展,代码可能变得复杂。定期进行重构,以保持代码的简洁性和可读性,是保持代码可维护性的关键。 以上9条最佳实践旨在指导开发者创建易于...

    「安全研究」安全代码审查-S-SDLC与安全代码审查 - 安全意识.zip

    安全代码审查是软件开发生命周期(Software Development Life Cycle, SDLC)中的一个重要环节,它与数据安全密切相关,旨在发现并修复程序中的潜在安全漏洞,从而提高软件的安全性。在这个主题中,我们将深入探讨...

    轻量级代码审查工具 JavaViwer1.0说明书

    JavaViewer 1.0 的设计模型可能基于软件工程中的最佳实践,如: 1. **模块化**:工具各功能模块相互独立,便于维护和扩展。 2. **面向对象**:利用Java的面向对象特性,实现代码的封装、继承和多态。 3. **可配置性*...

    代码审查:追求有效和高效的敏捷代码审查

    5. **定期培训**:组织关于最佳实践和新工具的培训,提升团队的整体审查能力。 在敏捷环境中,代码审查需要与敏捷原则相结合,如持续集成和持续交付(CI/CD)。这要求审查过程快速且有针对性,避免阻塞开发进度。...

    代码审查表1

    代码审查是软件开发过程中的一个重要环节,它有助于提高代码质量,发现潜在的错误,以及确保遵循最佳实践。本文将详细探讨“代码审查表1”所涉及的各个方面,并提供相关知识点。 1. **代码审查的目的**: - 提升...

Global site tag (gtag.js) - Google Analytics