zoukankan      html  css  js  c++  java
  • 第七周作业

    Checkstyle进行代码审查的实例

    1、什么是Checkstyle?

      Checkstyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。[1]

    2、Checkstyle主要检验哪些内容?

      Checkstyle检验的主要内容有:Javadoc注释、命名约定、标题、Import语句、体积大小、空白、修饰符、块、代码问题、类设计以及混合检查(包括一些有用的比如非必须的System.out和printstackTrace)。[1]

    3、如何使用Checkstyle进行代码审查?

    (1)新建Test测试类

    (2)右击Test类--> Checkstyle --> Check Code with CheckStyle

    (3) Problem:Line contains a tab character. 代码行里包含“Tab”字符。

      Solution:通过“Ctrl+F”将“Tab”字符替换为两个空格。

    (4) Problem:Local variable name 'a' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. 变量“a”,“b”的命名不符合命名规则。

      Solution:将变量名a,b改成plusA,plusB。

    (5) Problem:WhitespaceAround: '+' is not followed by whitespace. “+”字符后面没有空格。

      Solution:在“+”,“=”后面都添加一个空格。

    (6) Problem:WhitespaceAround: '+' is not preceded with whitespace. “+”字符前面没有空格。

      Solution:在“+”,“=”前面都添加一个空格。

    (7) Problem:Each variable declaration must be in its own statement. 每一个变量声明必须在它自己的语句中。

      Solution:把变量plusA,plusB分开声明。

    (8) Problem:Missing a Javadoc comment.方法前面缺少Javadoc的注释。

      Solution:在main方法前面加上Javadoc的注释。

    参考:

    [1]http://baike.baidu.com/link?url=THmLmNuGCv-XmnwRaV-yEpcPGcE50n5alJeQf83NxRB9RtcTML61C3RIhypwEHPLX3SI56jydiz9Oct631sbsa

    [2]http://www.cnblogs.com/bluesky4485/archive/2011/11/30/2269198.html

  • 相关阅读:
    DGA域名可以是色情网站域名
    使用cloudflare加速你的网站隐藏你的网站IP
    167. Two Sum II
    leetcode 563. Binary Tree Tilt
    python 多线程
    leetcode 404. Sum of Left Leaves
    leetcode 100. Same Tree
    leetcode 383. Ransom Note
    leetcode 122. Best Time to Buy and Sell Stock II
    天津Uber优步司机奖励政策(12月28日到12月29日)
  • 原文地址:https://www.cnblogs.com/xiaolili0309/p/5399800.html
Copyright © 2011-2022 走看看