2264 lines
76 KiB
HTML
2264 lines
76 KiB
HTML
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="description" content="Learn how to use CPD, the copy-paste detector shipped with PMD.">
|
||
<meta name="keywords" content="cpduserdocs, ">
|
||
<title>Finding duplicated code with CPD | PMD Source Code Analyzer</title>
|
||
<link rel="stylesheet" href="css/syntax.css">
|
||
|
||
|
||
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
|
||
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
|
||
<link rel="stylesheet" href="css/modern-business.css">
|
||
<link rel="stylesheet" href="css/lavish-bootstrap.css">
|
||
<link rel="stylesheet" href="css/customstyles.css">
|
||
<link rel="stylesheet" href="css/theme-blue.css">
|
||
<link rel="stylesheet" href="css/pmd-customstyles.css">
|
||
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
|
||
<script src="js/jquery.navgoco.min.js"></script>
|
||
|
||
|
||
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
|
||
<script src="js/toc.js"></script>
|
||
<script src="js/customscripts.js"></script>
|
||
|
||
<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">
|
||
<link rel="icon" href="images/favicon.ico" type="image/x-icon">
|
||
|
||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
|
||
<!--[if lt IE 9]>
|
||
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
|
||
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<link rel="alternate" type="application/rss+xml" title="" href="https://pmd.github.io/pmd/feed.xml">
|
||
|
||
<script>
|
||
$(document).ready(function() {
|
||
// Initialize navgoco with default options
|
||
$("#mysidebar").navgoco({
|
||
caretHtml: '',
|
||
accordion: true,
|
||
openClass: 'active', // open
|
||
save: false, // leave false or nav highlighting doesn't work right
|
||
cookie: {
|
||
name: 'navgoco',
|
||
expires: false,
|
||
path: '/'
|
||
},
|
||
slide: {
|
||
duration: 400,
|
||
easing: 'swing'
|
||
}
|
||
});
|
||
|
||
$("#collapseAll").click(function(e) {
|
||
e.preventDefault();
|
||
$("#mysidebar").navgoco('toggle', false);
|
||
});
|
||
|
||
$("#expandAll").click(function(e) {
|
||
e.preventDefault();
|
||
$("#mysidebar").navgoco('toggle', true);
|
||
});
|
||
|
||
});
|
||
|
||
</script>
|
||
<script>
|
||
$(function () {
|
||
$('[data-toggle="tooltip"]').tooltip()
|
||
})
|
||
</script>
|
||
<script>
|
||
$(document).ready(function() {
|
||
$("#tg-sb-link").click(function() {
|
||
$("#tg-sb-sidebar").toggle();
|
||
$("#tg-sb-content").toggleClass('col-md-9');
|
||
$("#tg-sb-content").toggleClass('col-md-12');
|
||
$("#tg-sb-icon").toggleClass('fa-toggle-on');
|
||
$("#tg-sb-icon").toggleClass('fa-toggle-off');
|
||
});
|
||
});
|
||
</script>
|
||
|
||
|
||
</head>
|
||
<body>
|
||
<!-- Content is offset by the height of the topnav bar. -->
|
||
<!-- There's already a padding-top rule in modern-business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
|
||
<div id="topbar-content-offset">
|
||
<!-- Navigation -->
|
||
<nav class="navbar navbar-inverse navbar-fixed-top">
|
||
<div class="container topnavlinks">
|
||
<div class="navbar-header">
|
||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
|
||
<span class="sr-only">Toggle navigation</span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a class="fa fa-home fa-lg navbar-brand" href="index.html"> <span class="projectTitle"> PMD Source Code Analyzer Project</span></a>
|
||
</div>
|
||
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
|
||
<ul class="nav navbar-nav navbar-right">
|
||
<!-- toggle sidebar button -->
|
||
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
|
||
<!-- entries without drop-downs appear here -->
|
||
|
||
|
||
|
||
<li><a href="https://github.com/pmd/pmd/releases/latest" target="_blank">Download</a></li>
|
||
|
||
|
||
|
||
<li><a href="https://github.com/pmd/pmd" target="_blank">Fork us on github</a></li>
|
||
|
||
|
||
|
||
<!-- entries with drop-downs appear here -->
|
||
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
|
||
|
||
|
||
<!--comment out this block if you want to hide search-->
|
||
<li>
|
||
<!--start search-->
|
||
<div id="search-demo-container">
|
||
<input type="text" id="search-input" placeholder="search...">
|
||
<ul id="results-container"></ul>
|
||
</div>
|
||
<script src="js/jekyll-search.js" type="text/javascript"></script>
|
||
<script type="text/javascript">
|
||
SimpleJekyllSearch.init({
|
||
searchInput: document.getElementById('search-input'),
|
||
resultsContainer: document.getElementById('results-container'),
|
||
dataSource: 'search.json',
|
||
searchResultTemplate: '<li><a href="{url}" title="Finding duplicated code with CPD">{title}</a></li>',
|
||
noResultsText: 'No results found.',
|
||
limit: 10,
|
||
fuzzy: true,
|
||
})
|
||
</script>
|
||
<!--end search-->
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<!-- /.container -->
|
||
</nav>
|
||
|
||
<!-- Page Content -->
|
||
<div class="container">
|
||
<div class="col-lg-12"> </div>
|
||
<!-- Content Row -->
|
||
<div class="row">
|
||
|
||
|
||
<!-- Sidebar Column -->
|
||
<div class="col-md-3" id="tg-sb-sidebar">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<ul id="mysidebar" class="nav">
|
||
<li class="sidebarTitle">PMD 6.8.0</li>
|
||
|
||
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="#">About</a>
|
||
|
||
<ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="index.html">Home</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_release_notes.html">Release notes</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_about_help.html">Getting help</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="#">User Documentation</a>
|
||
|
||
<ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_installation.html">Installation and basic CLI usage</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_making_rulesets.html">Making rulesets</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_configuring_rules.html">Configuring rules</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_best_practices.html">Best practices</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_suppressing_warnings.html">Suppressing warnings</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_incremental_analysis.html">Incremental analysis</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_cli_reference.html">PMD CLI reference</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Extending PMD</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_extending_writing_pmd_rules.html">Writing a rule</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_extending_writing_xpath_rules.html">Writing XPath rules</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_extending_defining_properties.html">Defining rule properties</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_extending_metrics_howto.html">Using and defining code metrics</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_extending_rule_guidelines.html">Rule guidelines</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_extending_testing.html">Testing your rules</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="active"><a href="pmd_userdocs_cpd.html">Copy-paste detection</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Tools / Integrations</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_tools_maven.html">Maven PMD plugin</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_tools_ant.html">Ant</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_tools_ci.html">CI integrations</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_userdocs_tools.html">Other Tools / Integrations</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="#">Rule Reference</a>
|
||
|
||
<ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Apex Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_apex.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_apex_bestpractices.html">Best Practices</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_apex_codestyle.html">Code Style</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_apex_design.html">Design</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_apex_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_apex_performance.html">Performance</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_apex_security.html">Security</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Ecmascript Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_ecmascript.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_ecmascript_bestpractices.html">Best Practices</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_ecmascript_codestyle.html">Code Style</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_ecmascript_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Java Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_bestpractices.html">Best Practices</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_codestyle.html">Code Style</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_design.html">Design</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_documentation.html">Documentation</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_multithreading.html">Multithreading</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_performance.html">Performance</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_java_security.html">Security</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Java Server Pages Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_jsp.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_jsp_bestpractices.html">Best Practices</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_jsp_codestyle.html">Code Style</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_jsp_design.html">Design</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_jsp_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_jsp_security.html">Security</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Maven POM Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_pom.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_pom_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">PLSQL Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_plsql.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_plsql_bestpractices.html">Best Practices</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_plsql_codestyle.html">Code Style</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_plsql_design.html">Design</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_plsql_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Salesforce VisualForce Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_vf.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_vf_security.html">Security</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">VM Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_vm.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_vm_bestpractices.html">Best Practices</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_vm_design.html">Design</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_vm_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">XML Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_xml.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_xml_errorprone.html">Error Prone</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">XSL Rules</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_xsl.html">Index</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_xsl_codestyle.html">Code Style</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_rules_xsl_performance.html">Performance</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="#">Language Specific Documentation</a>
|
||
|
||
<ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_languages_jsp.html">JSP Support</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_java_metrics_index.html">Java code metrics</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_apex_metrics_index.html">Apex code metrics</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="#">Developer Documentation</a>
|
||
|
||
<ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_development.html">Developer resources</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_building.html">Building PMD from source</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_writing_documentation.html">Writing documentation</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_roadmap.html">Roadmap</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_how_pmd_works.html">How PMD works</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_pmdtester.html">Pmdtester</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Major contributions</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_major_adding_new_language.html">Adding a new language</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_major_adding_new_cpd_language.html">Adding a new CPD language</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_devdocs_major_adding_new_metrics_framework.html">Adding metrics support to a language</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="#">Project documentation</a>
|
||
|
||
<ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Trivia about PMD</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_trivia_news.html">PMD in the press</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_trivia_products.html">Products & books related to PMD</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_trivia_similarprojects.html">Similar projects</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_trivia_meaning.html">What does 'PMD' mean?</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_faq.html">FAQ</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="license.html">License</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_credits.html">Credits</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_release_notes_old.html">Old release notes</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="subfolders">
|
||
<a href="#">Project management</a>
|
||
<ul>
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_committers_releasing.html">Release process</a></li>
|
||
|
||
|
||
|
||
|
||
|
||
<li><a href="pmd_projectdocs_committers_merging_pull_requests.html">Merging pull requests</a></li>
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
<!-- if you aren't using the accordion, uncomment this block:
|
||
<p class="external">
|
||
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
|
||
</p>
|
||
-->
|
||
</ul>
|
||
|
||
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
|
||
<script>$("li.active").parents('li').toggleClass("active");</script>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<!-- Content Column -->
|
||
<div class="col-md-9" id="tg-sb-content">
|
||
<div class="post-header">
|
||
<h1 class="post-title-main">Finding duplicated code with CPD</h1>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="post-content">
|
||
|
||
|
||
<div class="summary">Learn how to use CPD, the copy-paste detector shipped with PMD.</div>
|
||
|
||
|
||
|
||
|
||
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
|
||
<script>
|
||
$( document ).ready(function() {
|
||
// Handler for .ready() called.
|
||
|
||
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
|
||
|
||
});
|
||
</script>
|
||
|
||
<div id="toc"></div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a target="_blank" href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/cpd.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
|
||
|
||
|
||
|
||
<h2 id="overview">Overview</h2>
|
||
|
||
<p>Duplicate code can be hard to find, especially in a large project.
|
||
But PMD’s Copy/Paste Detector (CPD) can find it for you!
|
||
CPD has been through three major incarnations:</p>
|
||
|
||
<ul>
|
||
<li>
|
||
<p>First we wrote it using a variant of Michael Wise’s Greedy String Tiling algorithm (our variant is described
|
||
<a href="http://www.onjava.com/pub/a/onjava/2003/03/12/pmd_cpd.html">here</a>).</p>
|
||
</li>
|
||
<li>
|
||
<p>Then it was completely rewritten by Brian Ewins using the
|
||
<a href="http://dogma.net/markn/articles/bwt/bwt.htm">Burrows-Wheeler transform</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Finally, it was rewritten by Steve Hawkins to use the
|
||
<a href="http://www.nist.gov/dads/HTML/karpRabin.html">Karp-Rabin</a> string matching algorithm.</p>
|
||
</li>
|
||
</ul>
|
||
|
||
<p>Each rewrite made it much faster, and now it can process the JDK 1.4 java.* packages in about 4 seconds
|
||
(on my workstation, at least).</p>
|
||
|
||
<p>Note that CPD works with Java, JSP, C, C++, C#, Fortran and PHP code and some more languages. For the
|
||
full list, see below <a href="#supported-languages">Supported Languages</a>. Your own language is missing?
|
||
See how to add it <a href="/pmd_devdocs_adding_new_cpd_language.html">here</a>.</p>
|
||
|
||
<p>CPD is included with PMD, which you can download <a href="http://sourceforge.net/projects/pmd/files/pmd/">here</a>.</p>
|
||
|
||
<h3 id="cli-options">CLI options</h3>
|
||
|
||
<table>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
<th>Applies to</th>
|
||
</tr>
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-minimum-tokens"><code>--minimum-tokens</code></a></td>
|
||
<td><span class="label label-primary">Required</span> The minimum token length which should be reported as a duplicate.</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-files"><code>--files</code></a></td>
|
||
<td><span class="label label-primary">Required</span> List of files and directories to process</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-filelist"><code>--filelist</code></a></td>
|
||
<td>Path to file containing a comma delimited list of files to analyze. If this is given, then you don't need to provide <code>--files</code>.</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-language"><code>--language</code></a></td>
|
||
<td>Sources code language.</td>
|
||
<td><code>java</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-encoding"><code>--encoding</code></a></td>
|
||
<td>Character encoding to use when processing files. If not specified, CPD uses the system default encoding.</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-skip-duplicate-files"><code>--skip-duplicate-files</code></a></td>
|
||
<td>Ignore multiple copies of files of the same name and length in comparison.</td>
|
||
<td><code>false</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-exclude"><code>--exclude</code></a></td>
|
||
<td>Files to be excluded from CPD check</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-non-recursive"><code>--non-recursive</code></a></td>
|
||
<td>Don't scan subdirectories</td>
|
||
<td><code>false</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-skip-lexical-errors"><code>--skip-lexical-errors</code></a></td>
|
||
<td>Skip files which can't be tokenized due to invalid characters instead of aborting CPD</td>
|
||
<td><code>false</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-format"><code>--format</code></a></td>
|
||
<td>Report format.</td>
|
||
<td><code>text</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-failOnViolation"><code>--failOnViolation <bool></code></a></td>
|
||
<td>By default CPD exits with status 4 if code duplications are found.
|
||
Disable this option with <code>--failOnViolation false</code> to exit with 0 instead and just write the report.</td>
|
||
<td><code>true</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-ignore-literals"><code>--ignore-literals</code></a></td>
|
||
<td>Ignore number values and string contents when comparing text</td>
|
||
<td><code>false</code></td>
|
||
<td>Java</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-ignore-identifiers"><code>--ignore-identifiers</code></a></td>
|
||
<td>Ignore constant and variable names when comparing text</td>
|
||
<td><code>false</code></td>
|
||
<td>Java</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-ignore-annotations"><code>--ignore-annotations</code></a></td>
|
||
<td>Ignore language annotations when comparing text</td>
|
||
<td><code>false</code></td>
|
||
<td>Java</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-ignore-usings"><code>--ignore-usings</code></a></td>
|
||
<td>Ignore <code>using</code> directives in C# when comparing text</td>
|
||
<td><code>false</code></td>
|
||
<td>C#</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-no-skip-blocks"><code>--no-skip-blocks</code></a></td>
|
||
<td>Do not skip code blocks matched by <code>--skip-blocks-pattern</code></td>
|
||
<td><code>false</code></td>
|
||
<td>C++</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-skip-blocks-pattern"><code>--skip-blocks-pattern</code></a></td>
|
||
<td>Pattern to find the blocks to skip. It is a string property and contains of two parts,
|
||
separated by <code>|</code>. The first part is the start pattern, the second part is the ending pattern.</td>
|
||
<td><code>#if 0|#endif</code></td>
|
||
<td>C++</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-uri"><code>--uri</code></a></td>
|
||
<td>URI to process</td>
|
||
<td><code></code></td>
|
||
<td>PLSQL</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="-help"><code>--help</code><br /><code>-h</code></a></td>
|
||
<td>Print help text</td>
|
||
<td><code>false</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
</table>
|
||
|
||
<h3 id="examples">Examples</h3>
|
||
|
||
<p><em>Note:</em> The following example use the Linux start script. For Windows, just replace “./run.sh cpd” by “cpd.bat”.</p>
|
||
|
||
<p>Minimum required options: Just give it the minimum duplicate size and the source directory:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./run.sh cpd --minimum-tokens 100 --files /usr/local/java/src/java
|
||
</code></pre></div></div>
|
||
|
||
<p>You can also specify the language:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./run.sh cpd --minimum-tokens 100 --files /path/to/c/source --language cpp
|
||
</code></pre></div></div>
|
||
|
||
<p>You may wish to check sources that are stored in different directories:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./run.sh cpd --minimum-tokens 100 --files /path/to/other/source --files /path/to/other/source --files /path/to/other/source --language fortran
|
||
</code></pre></div></div>
|
||
|
||
<p><em>There should be no limit to the number of ‘–files’, you may add… But if you stumble one, please tell us !</em></p>
|
||
|
||
<p>And if you’re checking a C source tree with duplicate files in different architecture directories
|
||
you can skip those using –skip-duplicate-files:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./run.sh cpd --minimum-tokens 100 --files /path/to/c/source --language cpp --skip-duplicate-files
|
||
</code></pre></div></div>
|
||
|
||
<p>You can also specify the encoding to use when parsing files:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./run.sh cpd --minimum-tokens 100 --files /usr/local/java/src/java --encoding utf-16le
|
||
</code></pre></div></div>
|
||
|
||
<p>You can also specify a report format - here we’re using the XML report:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./run.sh cpd --minimum-tokens 100 --files /usr/local/java/src/java --format xml
|
||
</code></pre></div></div>
|
||
|
||
<p>The default format is a text report, and there’s also a <code class="highlighter-rouge">csv</code> report.</p>
|
||
|
||
<p>Note that CPD is pretty memory-hungry; you may need to give Java more memory to run it, like this:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ export HEAPSIZE=512m
|
||
$ ./run.sh cpd --minimum-tokens 100 --files /usr/local/java/src/java
|
||
</code></pre></div></div>
|
||
|
||
<p>In order to change the heap size under Windows, you’ll need to edit the batch file <code class="highlighter-rouge">cpd.bat</code> set the “OPTS”
|
||
variable to <code class="highlighter-rouge">-Xmx512m</code>.</p>
|
||
|
||
<p>If you specify a source directory but don’t want to scan the sub-directories, you can use the non-recursive option:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./run.sh cpd --minimum-tokens 100 --non-recursive --files /usr/local/java/src/java
|
||
</code></pre></div></div>
|
||
|
||
<h3 id="exit-status">Exit status</h3>
|
||
|
||
<p>Please note that if CPD detects duplicated source code, it will exit with status 4 (since 5.0).
|
||
This behavior has been introduced to ease CPD integration into scripts or hooks, such as SVN hooks.</p>
|
||
|
||
<table>
|
||
<tr><td>0</td><td>Everything is fine, now code duplications found</td></tr>
|
||
<tr><td>1</td><td>Couldn't understand command line parameters or CPD exited with an exception</td></tr>
|
||
<tr><td>4</td><td>At least one code duplication has been detected unless '--failOnViolation false' is used.</td></tr>
|
||
</table>
|
||
|
||
<h3 id="supported-languages">Supported Languages</h3>
|
||
|
||
<ul>
|
||
<li>Apex</li>
|
||
<li>C#</li>
|
||
<li>C/C++</li>
|
||
<li>EcmaScript (JavaScript)</li>
|
||
<li>Fortran</li>
|
||
<li>Go</li>
|
||
<li>Groovy</li>
|
||
<li>Java</li>
|
||
<li>Jsp</li>
|
||
<li>Matlab</li>
|
||
<li>Objective-C</li>
|
||
<li>Perl</li>
|
||
<li>PHP</li>
|
||
<li>PL/SQL</li>
|
||
<li>Python</li>
|
||
<li>Ruby</li>
|
||
<li>Scala</li>
|
||
<li>Swift</li>
|
||
<li>Visualforce</li>
|
||
</ul>
|
||
|
||
<h3 id="available-report-formats">Available report formats</h3>
|
||
|
||
<ul>
|
||
<li>text : Default format</li>
|
||
<li>xml</li>
|
||
<li>csv</li>
|
||
<li>csv_with_linecount_per_file</li>
|
||
<li>vs</li>
|
||
</ul>
|
||
|
||
<h2 id="ant-task">Ant task</h2>
|
||
|
||
<p>Andy Glover wrote an Ant task for CPD; here’s how to use it:</p>
|
||
|
||
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><target</span> <span class="na">name=</span><span class="s">"cpd"</span><span class="nt">></span>
|
||
<span class="nt"><taskdef</span> <span class="na">name=</span><span class="s">"cpd"</span> <span class="na">classname=</span><span class="s">"net.sourceforge.pmd.cpd.CPDTask"</span> <span class="nt">/></span>
|
||
<span class="nt"><cpd</span> <span class="na">minimumTokenCount=</span><span class="s">"100"</span> <span class="na">outputFile=</span><span class="s">"/home/tom/cpd.txt"</span><span class="nt">></span>
|
||
<span class="nt"><fileset</span> <span class="na">dir=</span><span class="s">"/home/tom/tmp/ant"</span><span class="nt">></span>
|
||
<span class="nt"><include</span> <span class="na">name=</span><span class="s">"**/*.java"</span><span class="nt">/></span>
|
||
<span class="nt"></fileset></span>
|
||
<span class="nt"></cpd></span>
|
||
<span class="nt"></target></span>
|
||
</code></pre></div></div>
|
||
|
||
<!-- TODO avoid duplicating the descriptions! -->
|
||
|
||
<h3 id="attribute-reference">Attribute reference</h3>
|
||
|
||
<table>
|
||
<tr>
|
||
<th>Attribute</th>
|
||
<th>Description</th>
|
||
<th>Default</th>
|
||
<th>Applies to</th>
|
||
</tr>
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="minimumtokencount"><code>minimumtokencount</code></a></td>
|
||
<td><span class="label label-primary">Required</span> A positive integer indicating the minimum duplicate size.</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="encoding"><code>encoding</code></a></td>
|
||
<td>The character set encoding (e.g., UTF-8) to use when reading the source code files, but also when
|
||
producing the report. A piece of warning, even if you set properly the encoding value,
|
||
let's say to UTF-8, but you are running CPD encoded with CP1252, you may end up with not UTF-8 file.
|
||
Indeed, CPD copy piece of source code in its report directly, therefore, the source files
|
||
keep their encoding.<br />
|
||
If not specified, CPD uses the system default encoding.</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="format"><code>format</code></a></td>
|
||
<td>The format of the report (e.g. <code>csv</code>, <code>text</code>, <code>xml</code>).</td>
|
||
<td><code>text</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="ignoreLiterals"><code>ignoreLiterals</code></a></td>
|
||
<td>if <code>true</code>, CPD ignores literal value differences when evaluating a duplicate
|
||
block. This means that <code>foo=42;</code> and <code>foo=43;</code> will be seen as equivalent. You may want
|
||
to run PMD with this option off to start with and then switch it on to see what it turns up.</td>
|
||
<td><code>false</code></td>
|
||
<td>Java</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="ignoreIdentifiers"><code>ignoreIdentifiers</code></a></td>
|
||
<td>Similar to <code>ignoreLiterals</code> but for identifiers; i.e., variable names, methods names, and so forth.</td>
|
||
<td><code>false</code></td>
|
||
<td>Java</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="ignoreAnnotations"><code>ignoreAnnotations</code></a></td>
|
||
<td>Ignore annotations. More and more modern frameworks use annotations on classes and methods,
|
||
which can be very redundant and trigger CPD matches. With J2EE (CDI, Transaction Handling, etc)
|
||
and Spring (everything) annotations become very redundant. Often classes or methods have the
|
||
same 5-6 lines of annotations. This causes false positives.</td>
|
||
<td><code>false</code></td>
|
||
<td>Java</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="ignoreUsings"><code>ignoreUsings</code></a></td>
|
||
<td>Ignore using directives in C#.</td>
|
||
<td><code>false</code></td>
|
||
<td>C#</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="skipDuplicateFiles"><code>skipDuplicateFiles</code></a></td>
|
||
<td>Ignore multiple copies of files of the same name and length in comparison.</td>
|
||
<td><code>false</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="skipLexicalErrors"><code>skipLexicalErrors</code></a></td>
|
||
<td>Skip files which can't be tokenized due to invalid characters instead of aborting CPD.</td>
|
||
<td><code>false</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="skipBlocks"><code>skipBlocks</code></a></td>
|
||
<td>Enables or disabled skipping of blocks like a pre-processor. See also option skipBlocksPattern.</td>
|
||
<td><code>true</code></td>
|
||
<td>C++</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="skipBlocksPattern"><code>skipBlocksPattern</code></a></td>
|
||
<td>Configures the pattern, to find the blocks to skip. It is a string property and contains of two parts,
|
||
separated by <code>|</code>. The first part is the start pattern, the second part is the ending pattern.</td>
|
||
<td><code>#if 0|#endif</code></td>
|
||
<td>C++</td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="language"><code>language</code></a></td>
|
||
<td>Flag to select the appropriate language (e.g. <code>c</code>, <code>cpp</code>, <code>cs</code>, <code>java</code>, <code>jsp</code>, <code>php</code>, <code>ruby</code>, <code>fortran</code>
|
||
<code>ecmascript</code>, and <code>plsql</code>).</td>
|
||
<td><code>java</code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
<!-- Row of the CLI reference table, describing an option -->
|
||
<!-- Rows can be linked to the name of the option (without leading dash) -->
|
||
<!-- Argument summary: -->
|
||
<!-- options: comma separated list of aliases for the option.-->
|
||
<!-- option_arg: optional name for the argument of the option, eg 'arg', will be formatted eg to '<arg>'-->
|
||
<!-- description: description, you can use "some" inline markdown -->
|
||
<!-- required: whether the option is required, if specified, whatever the value, it's considered required -->
|
||
<!-- languages: languages to which the option applies -->
|
||
<!-- default: default value -->
|
||
|
||
|
||
|
||
<!-- fragment id in the page -->
|
||
|
||
|
||
<tr>
|
||
<td><a style="pointer-events: none; cursor: default;" name="outputfile"><code>outputfile</code></a></td>
|
||
<td>The destination file for the report. If not specified the console will be used instead.</td>
|
||
<td><code></code></td>
|
||
<td></td>
|
||
</tr>
|
||
|
||
</table>
|
||
|
||
<p>Also, you can get verbose output from this task by running ant with the <code class="highlighter-rouge">-v</code> flag; i.e.:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ant -v -f mybuildfile.xml cpd
|
||
</code></pre></div></div>
|
||
|
||
<p>Also, you can get an HTML report from CPD by using the XSLT script in pmd/etc/xslt/cpdhtml.xslt. Just run
|
||
the CPD task as usual and right after it invoke the Ant XSLT script like this:</p>
|
||
|
||
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><xslt</span> <span class="na">in=</span><span class="s">"cpd.xml"</span> <span class="na">style=</span><span class="s">"etc/xslt/cpdhtml.xslt"</span> <span class="na">out=</span><span class="s">"cpd.html"</span> <span class="nt">/></span>
|
||
</code></pre></div></div>
|
||
|
||
<h2 id="gui">GUI</h2>
|
||
|
||
<p>CPD also comes with a simple GUI. You can start it via some scripts in the <code class="highlighter-rouge">bin</code> folder:</p>
|
||
|
||
<p>For Windows:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cpdgui.bat
|
||
</code></pre></div></div>
|
||
|
||
<p>For Linux:</p>
|
||
|
||
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>./run.sh cpdgui
|
||
</code></pre></div></div>
|
||
|
||
<p>Here’s a screenshot of CPD after running on the JDK 8 java.lang package:</p>
|
||
|
||
<figure><img class="docimage" src="images/userdocs/screenshot_cpd.png" alt="CPD Screenshot after running on the JDK 8 java.lang package" /></figure>
|
||
|
||
<h2 id="suppression">Suppression</h2>
|
||
|
||
<p>Arbitrary blocks of code can be ignored through comments on <strong>Java</strong>, <strong>C/C++</strong>, <strong>Javascript</strong>, <strong>Matlab</strong>,
|
||
<strong>Objective-C</strong>, <strong>PL/SQL</strong> and <strong>Python</strong> by including the keywords <code class="highlighter-rouge">CPD-OFF</code> and <code class="highlighter-rouge">CPD-ON</code>.</p>
|
||
|
||
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="kd">public</span> <span class="n">Object</span> <span class="nf">someParameterizedFactoryMethod</span><span class="o">(</span><span class="kt">int</span> <span class="n">x</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
|
||
<span class="c1">// some unignored code</span>
|
||
|
||
<span class="c1">// tell cpd to start ignoring code - CPD-OFF</span>
|
||
|
||
<span class="c1">// mission critical code, manually loop unroll</span>
|
||
<span class="n">goDoSomethingAwesome</span><span class="o">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">x</span> <span class="o">/</span> <span class="mi">2</span><span class="o">);</span>
|
||
<span class="n">goDoSomethingAwesome</span><span class="o">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">x</span> <span class="o">/</span> <span class="mi">2</span><span class="o">);</span>
|
||
<span class="n">goDoSomethingAwesome</span><span class="o">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">x</span> <span class="o">/</span> <span class="mi">2</span><span class="o">);</span>
|
||
<span class="n">goDoSomethingAwesome</span><span class="o">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">x</span> <span class="o">/</span> <span class="mi">2</span><span class="o">);</span>
|
||
<span class="n">goDoSomethingAwesome</span><span class="o">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">x</span> <span class="o">/</span> <span class="mi">2</span><span class="o">);</span>
|
||
<span class="n">goDoSomethingAwesome</span><span class="o">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">x</span> <span class="o">/</span> <span class="mi">2</span><span class="o">);</span>
|
||
|
||
<span class="c1">// resume CPD analysis - CPD-ON</span>
|
||
|
||
<span class="c1">// further code will *not* be ignored</span>
|
||
<span class="o">}</span>
|
||
</code></pre></div></div>
|
||
|
||
<p>Additionally, <strong>Java</strong> allows to toggle suppression by adding the annotations
|
||
<strong><code class="highlighter-rouge">@SuppressWarnings("CPD-START")</code></strong> and <strong><code class="highlighter-rouge">@SuppressWarnings("CPD-END")</code></strong>
|
||
all code within will be ignored by CPD.</p>
|
||
|
||
<p>This approach however, is limited to the locations were <code class="highlighter-rouge">@SuppressWarnings</code> is accepted.
|
||
It’s legacy and the new comment’s based approch should be favored.</p>
|
||
|
||
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="c1">//enable suppression</span>
|
||
<span class="nd">@SuppressWarnings</span><span class="o">(</span><span class="s">"CPD-START"</span><span class="o">)</span>
|
||
<span class="kd">public</span> <span class="n">Object</span> <span class="nf">someParameterizedFactoryMethod</span><span class="o">(</span><span class="kt">int</span> <span class="n">x</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
|
||
<span class="c1">// any code here will be ignored for the duplication detection</span>
|
||
<span class="o">}</span>
|
||
<span class="c1">//disable suppression</span>
|
||
<span class="nd">@SuppressWarnings</span><span class="o">(</span><span class="err">"</span><span class="n">CPD</span><span class="o">-</span><span class="n">END</span><span class="o">)</span>
|
||
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">nextMethod</span><span class="o">()</span> <span class="o">{</span>
|
||
<span class="o">}</span>
|
||
</code></pre></div></div>
|
||
|
||
<p>Other languages currently have no support to suppress CPD reports. In the future,
|
||
the comment based approach will be extended to those of them that can support it.</p>
|
||
|
||
|
||
<div class="tags">
|
||
|
||
<b>Tags: </b>
|
||
|
||
|
||
|
||
|
||
|
||
<a href="tag_userdocs.html" class="btn btn-default navbar-btn cursorNorm" role="button">userdocs</a>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<hr class="shaded"/>
|
||
|
||
<footer>
|
||
<div class="row">
|
||
<div class="col-lg-12 footer">
|
||
©2018 PMD Open Source Project. All rights reserved. <br />
|
||
Site last generated: Sep 2, 2018 <br />
|
||
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
|
||
</div>
|
||
<!-- /.row -->
|
||
</div>
|
||
<!-- /.container -->
|
||
</div>
|
||
</div>
|
||
</body>
|
||
|
||
</html>
|