JCSC

news/2024/11/30 20:29:16/

JCSC

I.        简介

JCSCJava Coding Standard Checker――Java编码标准检验程序的简称。JCSC是检查源代码的强大工具,它用来检查高度可定义的代码标准和可能的坏代码。

编码标准包括了对类、接口、区段、参数等等的命名规则,同样也规定了类型(类/接口)的结构性方案,比如在哪里放置区段,在methods之前还是之后以及什么顺序。这个顺序通过可视化(图形)或者某些类型(实例、类、常数)来确定。对于程序来说也是一样适用的。这些规则都是高度个性化的。通过定义在代码中放置空白区域的位置和使用花括号的位置,可以大大增强可读性。正确的JavaDoc可以被强制分为几个级别。除了这些,它可以在代码中寻找漏洞潜在的bug—比如空的catch或排在末端的block、非默认的变换、类型“异常”的抛出、慢速代码,等等。

JCSC的特点:图形化的用户界面(UI)使规则设置轻松;命令行界面;可以产生JavaDoc风格的网页和兼容CruiseControlAnt task。同样,加入了NCSS/CCN的规格可以更轻易的评估代码质量。

 

开发状况:5 - Production/Stable

运行环境:网络环境、控制台(基于文本的)

面向用户:开发者

许 可 证:OSI 认证过的GNU通用公共许可证(GNU General Public LicenseGPL)

自然语言:英语

操作系统:独立于操作系统

编程语言:Java

    题:软件开发/编译工具、文档、质量保证

 

II.      基本扩展-规则编辑器用户界面(UI)

图形化的规则编辑器可以协助用户创建合适的规则。根据不同的tab,规则可以分为三个组。

Ant

Ant是很棒的制作工具。为了支持并且能够加以利用AntJCSC提供了Ant Task

Ant Task提供了两种应用方法:

1.解析一个文件,例如作为支持AntIDE中的一个插件。

2.解析整个包中的类树,例如在一个编译中,检查整个项目。输出形式类似于JavaDoc,并且可以用一个支持XSLT的浏览器来查看(分别通过了支持SP1的、支持IE6+的和支持Mozilla1+的环境下的测试)。

IntelliJ IDEA

IntelliJ IDEA是一个非常强大的商业化的IDE。这个插件仍在开发中(欢迎任何形式的反馈),但是很稳定。

CruiseControl

CruiseControl是一个开放源代码的延续集成(Continuous Integration)工具。JCSC可以轻易的与CruiseControl集成,这就意味着,每次检入后,软件将会分析你的代码库,结果将会出现在CruiseControl网页上。

 

III. 安装

命令行

1.由下载页中得到最新的JCSC.zip包。

2.解压至合适的文件夹,它将会创建一个jcsc文件夹。

3.设置一个JCSC_HOME环境变量,指向jcsc文件夹。

4.将JCSC_HOME/bin加入到系统PATH中。

5.运行JCSC需要J2SE1.3或者更高版本。

6.确认JAVA_HOME/bin在系统的PATH中。

Ant

1.安装JCSC的命令行

2.将JCSC.jargnu-regexp.jarwxrcesImp1.jarxml-apis.jar放入Ant库文件夹。

IntelliJ IDEA

1.由下载页中获得最新JCSC.zip包(如果没有安装命令行版本)。

2.由下载页中获得最新的intellijJCSC.zip包。

3.将intellijJCSC.zip解压至<IntelliJIDEA>/plugins文件夹。

4.将JCSC.zip解压至某个临时文件夹——如果你没有安装JCSC的话。

5.由库文件夹中拷贝JCSC.jar<IntelliJIDEA>/plugins/jcsc/lib文件夹。

6.打开IntelliJ IDEA,进入设置(Ctrl+Alt+S),点击intellijJCSC

    设置Rules文件——强制性的;

    设置Fail Severity——可选的;

    设置Fail Vio/NCSS的比例——可选的。

IV.  基本使用

命令行

安装好之后,你可以像使用其它命令一样使用它。注意命令行jcsc工具无法递归的扫描整个文件夹,除非你使用JCSC Ant Task。如果使用了-r的标记,JCSC首先会在JCSC_HOME/rules文件夹中寻找,如果找不到,它会试图在绝对路径中寻找:

jcsc [option] <file>|stream

根据你的平台,用jcsc.bat 或者jcsc.sh替换掉jcsc,并附带上下面的选项:

-h:显示帮助文件

-r<rule>:由文件系统中读取rule文件

-j<rule>:由jcsc.jar文件中读取rule文件

规则编辑器

JCSC_HOME/bin文件夹里运行规则编辑器脚本。用户读取的默认设置都存储于jar文件里。你可以修改它们,并把它们存入一个文件。你也可以打开已存在的文件,通过用户界面或者通过在命令行中传输rules文件名变量来实现。

 

规格

NCSS

NCSS是非注释性源码统计(Non Commenting Source Statements)的首字母缩写词。这里的数字代表了一个源文件中的纯功能码的行数。比较这个数字和违规的代码数量,可以容易的评估出代码的质量。

CCN

CCN是几何测圆法复杂度数量(Cyclometric Complexity Number)的首字母缩写词。数字表示代码流被分成多少个分支。默认的每个method有一个CCN

 

参考:

http://jcsc.sourceforge.net/

http://freshmeat.net/projects/jcsc


http://www.ppmy.cn/news/562415.html

相关文章

JCS

http://www.iteye.com/topic/206406

JSP+ssm计算机毕业设计大学生比赛赛事信息管理8jmqc【源码、数据库、LW、部署】

项目运行 项目含有源码、文档、程序、数据库、配套开发软件、软件安装教程 环境配置&#xff1a; Jdk1.8 Tomcat7.0 Mysql HBuilderX&#xff08;Webstorm也行&#xff09; Eclispe&#xff08;IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持&#xff09;。 项目技术&#xf…

jcs缓存机制

JCS缓存介绍 1. 概要 JCS是Jakarta的项目Turbine的子项目&#xff0c;它是复合式的缓冲工具&#xff0c;具有配置灵活的特点。JCS提供内存、硬盘、分布式架构、构建缓存服务器四种方式来实现对象缓存&#xff1b;能够很方便的实现缓存的差异化定制。缓冲工具对于读操作远远…

k8s ceph静态pv 多目录 多端口

一、准备工作 k8s部署见&#xff1a; https://blog.csdn.net/oToyix/article/details/117963839 ceph集群部署 见&#xff1a; https://blog.csdn.net/oToyix/article/details/118307711 yaml文件两个 ceph-nginx-pv-pvc.yaml (PV、PVC定义) nginx.yaml &#xff08;Deploymen…

严重: Error starting endpoint java.lang.Exception: Socket bind failed: [730048] ?????????×???(Э?é/????

前几天就发现这么一个问题&#xff0c;但是一直懒得解决~ 严重: Error initializing endpoint java.lang.Exception: Socket bind failed: [730048] ????????????(Э?/???????/???)??????at org.apache.tomcat.util.net.AprEndpoint.init(AprEnd…

JMS

1. JMS基本概念 JMS(Java Message Service) 即Java消息服务。它提供标准的产生、发送、接收消息的接口简化企业应用的开发。它支持两种消息通信模型&#xff1a;点到点&#xff08;point-to-point&#xff09;&#xff08;P2P&#xff09;模型和发布/订阅&#xff08;Pub/…

JSM

JSM学习笔记(只是为了记录just for 随记) 一、jsm&#xff1a;&#xff08;java message service &#xff09;java 消息服务&#xff0c;用于两个应用程序之间或者分布式系统之间进行消息的异步收发&#xff0c;是一个与具体平台无关的API&#xff0c;类似于JDBC&#xff08;…

jsc

之前发现一个神器&#xff0c;js代码测试脱离浏览器&#xff0c;mac终端也可以做到 调试js的时候&#xff0c;一般都是用浏览器的开发者工具&#xff0c;这里给大家推荐另外一种&#xff0c;抛开浏览器&#xff0c;在终端执行的方式,Mac内置了一个javascript控制台程序&#xf…