2020-11-14 09:20:07 +00:00
<!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 = "Rules which enforce a specific coding style." >
< meta name = "keywords" content = " Code Style, AvoidTabCharacter, CodeFormat, MisplacedPragma, ForLoopNaming, LineLength" >
< title > Code Style | 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 = "Code Style" > {title}< / a > < / li > ',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
< / script >
<!-- end search -->
< / li >
< / ul >
< / div >
< / div >
<!-- /.container -->
< / nav >
<!-- Page Content -->
2022-02-25 09:51:51 +00:00
< div class = "container-toc-wrapper" >
< div class = "container" >
< div class = "col-lg-12" > < / div >
<!-- Content Row -->
< div class = "row" >
2020-11-14 09:20:07 +00:00
2022-02-25 09:51:51 +00:00
<!-- Sidebar Column -->
< div class = "col-md-3" id = "tg-sb-sidebar" >
2020-11-14 09:20:07 +00:00
< ul id = "mysidebar" class = "nav" >
2022-08-31 18:17:17 +00:00
< li class = "sidebarTitle" > PMD 6.50.0-SNAPSHOT< / li >
< div class = "sidebarTitleDate" > Release date: 30-September-2022< / div >
2020-11-14 09:20:07 +00:00
< 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_next_major_development.html" > PMD 7.0.0 development< / 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 > < a href = "pmd_userdocs_report_formats.html" > PMD Report formats< / a > < / li >
< li class = "subfolders" >
< a href = "#" > CPD reference< / a >
< ul >
< li > < a href = "pmd_userdocs_cpd.html" > Copy-paste detection< / a > < / li >
< li > < a href = "pmd_userdocs_cpd_report_formats.html" > CPD Report formats< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Extending PMD< / a >
< ul >
< li > < a href = "pmd_userdocs_extending_writing_rules_intro.html" > Introduction to writing rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_your_first_rule.html" > Your first rule< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_xpath_rules.html" > XPath rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_java_rules.html" > Java rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_designer_reference.html" > Rule designer reference< / 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 = "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_gradle.html" > Gradle< / a > < / li >
< li > < a href = "pmd_userdocs_tools_ant.html" > Ant< / a > < / li >
< li > < a href = "pmd_userdocs_tools_java_api.html" > PMD Java API< / 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_documentation.html" > Documentation< / 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 >
2022-04-28 13:34:56 +00:00
< li class = "subfolders" >
< a href = "#" > HTML Rules< / a >
< ul >
< li > < a href = "pmd_rules_html.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_html_bestpractices.html" > Best Practices< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< 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 = "#" > Modelica Rules< / a >
< ul >
< li > < a href = "pmd_rules_modelica.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_modelica_bestpractices.html" > Best Practices< / 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 class = "active" > < 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 >
2022-03-27 15:04:13 +00:00
< li class = "subfolders" >
< a href = "#" > Java Support< / a >
< ul >
< li > < a href = "pmd_languages_java.html" > Java Versions< / a > < / li >
< li > < a href = "pmd_java_metrics_index.html" > Java Code Metrics< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li > < a href = "pmd_apex_metrics_index.html" > Apex code metrics< / a > < / li >
2021-03-26 08:22:23 +00:00
< li > < a href = "pmd_languages_plsql.html" > PLSQL< / a > < / li >
2021-10-29 17:50:40 +00:00
< li > < a href = "pmd_languages_visualforce.html" > Visualforce< / a > < / li >
2022-03-25 07:44:53 +00:00
< li > < a href = "pmd_languages_xml.html" > XML and XML dialects< / a > < / li >
2022-04-28 13:34:56 +00:00
< li > < a href = "pmd_languages_html.html" > HTML< / a > < / li >
2022-07-01 07:55:16 +00:00
< li > < a href = "pmd_languages_gherkin.html" > Gherkin< / a > < / li >
2022-04-28 13:34:56 +00:00
2020-11-14 09:20:07 +00:00
< / 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 > < a href = "pmd_devdocs_rule_deprecation_policy.html" > Rule Deprecation Policy< / a > < / li >
< li class = "subfolders" >
< a href = "#" > Major contributions< / a >
< ul >
2021-08-27 14:58:36 +00:00
< li > < a href = "pmd_devdocs_major_rule_guidelines.html" > Rule Guidelines< / a > < / li >
2020-11-14 09:20:07 +00:00
< 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 >
< li class = "subfolders" >
< a href = "#" > Experimental features< / a >
< ul >
< li > < a href = "pmd_devdocs_experimental_ast_dump.html" > Creating (XML) dump of the AST< / 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 >
2021-04-23 20:35:51 +00:00
< li > < a href = "pmd_projectdocs_committers_infrastructure.html" > Infrastructure< / a > < / li >
2020-11-14 09:20:07 +00:00
< 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 >
< li > < a href = "pmd_projectdocs_committers_main_landing_page.html" > Main Landing page< / 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 >
2022-02-25 09:51:51 +00:00
< / div >
2020-11-14 09:20:07 +00:00
2022-02-25 09:51:51 +00:00
<!-- Content Column -->
< div class = "col-md-9" id = "tg-sb-content" >
2022-03-24 11:42:13 +00:00
< header >
< div class = "row" >
< div class = "col-lg-12" >
< a href = "./" role = "button"
>< i class = "fa fa-home fa-lg" > < /i
>< / a >
» Code Style
< a
target="_blank"
href="https://github.com/pmd/pmd/blob/master/docs/../pmd-plsql/src/main/resources/category/plsql/codestyle.xml"
class="pull-right"
role="button"
>< i class = "fa fa-github fa-lg" > < / i > Edit on GitHub< /a
>
< / div >
< / div >
< hr / >
< / header >
< div class = "post-header" >
2020-11-14 09:20:07 +00:00
< h1 class = "post-title-main" > Code Style< / h1 >
< / div >
2022-03-24 11:42:13 +00:00
< div class = "post-content" data-github-edit-url = "https://github.com/pmd/pmd/blob/master/docs/../pmd-plsql/src/main/resources/category/plsql/codestyle.xml" >
2020-11-14 09:20:07 +00:00
< div class = "summary" > Rules which enforce a specific coding style.< / div >
2022-02-25 09:51:51 +00:00
< div id = "inline-toc" > <!-- empty, move TOC here when screen size too small --> < / div >
2020-11-14 09:20:07 +00:00
<!-- DO NOT EDIT THIS FILE. This file is generated from file ../pmd - plsql/src/main/resources/category/plsql/codestyle.xml. -->
< h2 id = "avoidtabcharacter" > AvoidTabCharacter< / h2 >
< p > < strong > Since:< / strong > PMD 6.13.0< / p >
< p > < strong > Priority:< / strong > Medium (3)< / p >
< p > This rule checks, that there are no tab characters (< code class = "language-plaintext highlighter-rouge" > \t< / code > ) in the source file.
It reports only the first occurrence per file.< / p >
< p > Using tab characters for indentation is not recommended, since this requires that every developer
uses the same tab with in their editor.< / p >
< p > This rule is the PMD equivalent of checkstyle’ < a href = "http://checkstyle.sourceforge.net/config_whitespace.html#FileTabCharacter" > FileTabCharacter< / a > check.< / p >
< p > < strong > This rule is defined by the following Java class:< / strong > < a href = "https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codestyle/AvoidTabCharacterRule.java" > net.sourceforge.pmd.lang.plsql.rule.codestyle.AvoidTabCharacterRule< / a > < / p >
< p > < strong > This rule has the following properties:< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Default Value< / th >
< th > Description< / th >
< th > Multivalued< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > eachLine< / td >
< td > false< / td >
< td > Whether to report each line with a tab character or only the first line< / td >
< td > no< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Use this rule with the default properties by just referencing it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/AvoidTabCharacter"< / span > < span class = "nt" > /> < / span >
< / code > < / pre > < / div > < / div >
< p > < strong > Use this rule and customize it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/AvoidTabCharacter"< / span > < span class = "nt" > > < / span >
< span class = "nt" > < properties> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > "eachLine"< / span > < span class = "na" > value=< / span > < span class = "s" > "false"< / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /properties> < / span >
< span class = "nt" > < /rule> < / span >
< / code > < / pre > < / div > < / div >
< h2 id = "codeformat" > CodeFormat< / h2 >
< p > < strong > Since:< / strong > PMD 6.9.0< / p >
< p > < strong > Priority:< / strong > Medium (3)< / p >
< p > This rule verifies that the PLSQL code is properly formatted. The following checks are executed:< / p >
< p > SQL Queries:< / p >
< ul >
< li > The selected columns must be each on a new line< / li >
< li > The keywords (BULK COLLECT INTO, FROM) start on a new line and are indented by one level< / li >
< li > UNION should be on the same indentation level as SELECT< / li >
< li > Each JOIN is on a new line. If there are more than one JOIN conditions, then each condition should be
on a separate line.< / li >
< / ul >
< p > Parameter definitions for procedures:< / p >
< ul >
< li > Each parameter should be on a new line< / li >
< li > Variable names as well as their types should be aligned< / li >
< / ul >
< p > Variable declarations:< / p >
< ul >
< li > Each variable should be on a new line< / li >
< li > Variable names as well as their types should be aligned< / li >
< / ul >
< p > Calling a procedure:< / p >
< ul >
< li > If there are more than 3 parameters
< ul >
< li > then named parameters should be used< / li >
< li > and each parameter should be on a new line< / li >
< / ul >
< / li >
< / ul >
< p > < strong > This rule is defined by the following Java class:< / strong > < a href = "https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codestyle/CodeFormatRule.java" > net.sourceforge.pmd.lang.plsql.rule.codestyle.CodeFormatRule< / a > < / p >
< p > < strong > Example(s):< / strong > < / p >
< div class = "language-sql highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "k" > BEGIN< / span >
< span class = "c1" > -- select columns each on a separate line< / span >
< span class = "k" > SELECT< / span > < span class = "n" > cmer_id< / span >
< span class = "p" > ,< / span > < span class = "k" > version< / span >
< span class = "p" > ,< / span > < span class = "n" > cmp_id< / span >
< span class = "n" > BULK< / span > < span class = "n" > COLLECT< / span > < span class = "k" > INTO< / span > < span class = "n" > v_cmer_ids< / span >
< span class = "p" > ,< / span > < span class = "n" > v_versions< / span >
< span class = "p" > ,< / span > < span class = "n" > v_cmp_ids< / span >
< span class = "k" > FROM< / span > < span class = "n" > cmer< / span > < span class = "p" > ;< / span >
< span class = "c1" > -- each parameter on a new line< / span >
< span class = "k" > PROCEDURE< / span > < span class = "n" > create_prospect< / span > < span class = "p" > (< / span >
< span class = "n" > company_info_in< / span > < span class = "k" > IN< / span > < span class = "n" > prospects< / span > < span class = "p" > .< / span > < span class = "n" > company_info< / span > < span class = "o" > %< / span > < span class = "k" > TYPE< / span > < span class = "c1" > -- Organization< / span >
< span class = "p" > ,< / span > < span class = "n" > firstname_in< / span > < span class = "k" > IN< / span > < span class = "n" > persons< / span > < span class = "p" > .< / span > < span class = "n" > firstname< / span > < span class = "o" > %< / span > < span class = "k" > TYPE< / span > < span class = "c1" > -- FirstName< / span >
< span class = "p" > ,< / span > < span class = "n" > lastname_in< / span > < span class = "k" > IN< / span > < span class = "n" > persons< / span > < span class = "p" > .< / span > < span class = "n" > lastname< / span > < span class = "o" > %< / span > < span class = "k" > TYPE< / span > < span class = "c1" > -- LastName< / span >
< span class = "p" > );< / span >
< span class = "c1" > -- more than three parameters, each parameter on a separate line< / span >
< span class = "n" > webcrm_marketing< / span > < span class = "p" > .< / span > < span class = "n" > prospect_ins< / span > < span class = "p" > (< / span >
< span class = "n" > cmp_id_in< / span > < span class = "o" > => < / span > < span class = "k" > NULL< / span >
< span class = "p" > ,< / span > < span class = "n" > company_info_in< / span > < span class = "o" > => < / span > < span class = "n" > company_info_in< / span >
< span class = "p" > ,< / span > < span class = "n" > firstname_in< / span > < span class = "o" > => < / span > < span class = "n" > firstname_in< / span >
< span class = "p" > ,< / span > < span class = "n" > lastname_in< / span > < span class = "o" > => < / span > < span class = "n" > lastname_in< / span >
< span class = "p" > ,< / span > < span class = "n" > slt_code_in< / span > < span class = "o" > => < / span > < span class = "k" > NULL< / span >
< span class = "p" > );< / span >
< span class = "k" > END< / span > < span class = "p" > ;< / span >
< / code > < / pre > < / div > < / div >
< p > < strong > This rule has the following properties:< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Default Value< / th >
< th > Description< / th >
< th > Multivalued< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > indentation< / td >
< td > 2< / td >
< td > Indentation to be used for blocks< / td >
< td > no< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Use this rule with the default properties by just referencing it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/CodeFormat"< / span > < span class = "nt" > /> < / span >
< / code > < / pre > < / div > < / div >
< p > < strong > Use this rule and customize it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/CodeFormat"< / span > < span class = "nt" > > < / span >
< span class = "nt" > < properties> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > "indentation"< / span > < span class = "na" > value=< / span > < span class = "s" > "2"< / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /properties> < / span >
< span class = "nt" > < /rule> < / span >
< / code > < / pre > < / div > < / div >
< h2 id = "forloopnaming" > ForLoopNaming< / h2 >
< p > < strong > Since:< / strong > PMD 6.7.0< / p >
< p > < strong > Priority:< / strong > Medium (3)< / p >
< p > In case you have loops please name the loop variables more meaningful.< / p >
< p > < strong > This rule is defined by the following XPath expression:< / strong > < / p >
< div class = "language-xpath highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "o" > //< / span > < span class = "nt" > CursorForLoopStatement< / span > < span class = "p" > [< / span > < span class = "w" >
< / span > < span class = "nv" > $allowSimpleLoops< / span > < span class = "w" > < / span > < span class = "err" > =< / span > < span class = "w" > < / span > < span class = "nf" > false< / span > < span class = "p" > ()< / span > < span class = "w" > < / span > < span class = "ow" > or< / span > < span class = "w" >
< / span > < span class = "p" > (< / span > < span class = "nt" > Statement< / span > < span class = "o" > //< / span > < span class = "nt" > CursorForLoopStatement< / span > < span class = "w" > < / span > < span class = "ow" > or< / span > < span class = "w" > < / span > < span class = "kn" > ancestor::< / span > < span class = "nt" > CursorForLoopStatement< / span > < span class = "p" > )< / span > < span class = "w" >
< / span > < span class = "p" > ]< / span > < span class = "w" >
< / span > < span class = "o" > /< / span > < span class = "nt" > ForIndex< / span > < span class = "p" > [< / span > < span class = "ow" > not< / span > < span class = "p" > (< / span > < span class = "nf" > matches< / span > < span class = "p" > (< / span > < span class = "na" > @Image< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nv" > $cursorPattern< / span > < span class = "p" > ))]< / span > < span class = "w" >
< / span > < span class = "p" > |< / span > < span class = "w" >
< / span > < span class = "o" > //< / span > < span class = "nt" > ForStatement< / span > < span class = "p" > [< / span > < span class = "w" >
< / span > < span class = "nv" > $allowSimpleLoops< / span > < span class = "w" > < / span > < span class = "err" > =< / span > < span class = "w" > < / span > < span class = "nf" > false< / span > < span class = "p" > ()< / span > < span class = "w" > < / span > < span class = "ow" > or< / span > < span class = "w" >
< / span > < span class = "p" > (< / span > < span class = "nt" > Statement< / span > < span class = "o" > //< / span > < span class = "nt" > ForStatement< / span > < span class = "w" > < / span > < span class = "ow" > or< / span > < span class = "w" > < / span > < span class = "kn" > ancestor::< / span > < span class = "nt" > ForStatement< / span > < span class = "p" > )< / span > < span class = "w" >
< / span > < span class = "p" > ]< / span > < span class = "w" >
< / span > < span class = "o" > /< / span > < span class = "nt" > ForIndex< / span > < span class = "p" > [< / span > < span class = "ow" > not< / span > < span class = "p" > (< / span > < span class = "nf" > matches< / span > < span class = "p" > (< / span > < span class = "na" > @Image< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "nv" > $indexPattern< / span > < span class = "p" > ))]< / span > < span class = "w" >
< / span > < / code > < / pre > < / div > < / div >
< p > < strong > Example(s):< / strong > < / p >
< div class = "language-sql highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "c1" > -- good example< / span >
< span class = "k" > BEGIN< / span >
< span class = "k" > FOR< / span > < span class = "n" > company< / span > < span class = "k" > IN< / span > < span class = "p" > (< / span > < span class = "k" > SELECT< / span > < span class = "o" > *< / span > < span class = "k" > FROM< / span > < span class = "n" > companies< / span > < span class = "p" > )< / span > < span class = "n" > LOOP< / span >
< span class = "k" > FOR< / span > < span class = "n" > contact< / span > < span class = "k" > IN< / span > < span class = "p" > (< / span > < span class = "k" > SELECT< / span > < span class = "o" > *< / span > < span class = "k" > FROM< / span > < span class = "n" > contacts< / span > < span class = "p" > )< / span > < span class = "n" > LOOP< / span >
< span class = "k" > FOR< / span > < span class = "n" > party< / span > < span class = "k" > IN< / span > < span class = "p" > (< / span > < span class = "k" > SELECT< / span > < span class = "o" > *< / span > < span class = "k" > FROM< / span > < span class = "n" > parties< / span > < span class = "p" > )< / span > < span class = "n" > LOOP< / span >
< span class = "k" > NULL< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "n" > LOOP< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "n" > LOOP< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "n" > LOOP< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "p" > ;< / span >
< span class = "o" > /< / span >
< span class = "c1" > -- bad example< / span >
< span class = "k" > BEGIN< / span >
< span class = "k" > FOR< / span > < span class = "n" > c1< / span > < span class = "k" > IN< / span > < span class = "p" > (< / span > < span class = "k" > SELECT< / span > < span class = "o" > *< / span > < span class = "k" > FROM< / span > < span class = "n" > companies< / span > < span class = "p" > )< / span > < span class = "n" > LOOP< / span >
< span class = "k" > FOR< / span > < span class = "n" > c2< / span > < span class = "k" > IN< / span > < span class = "p" > (< / span > < span class = "k" > SELECT< / span > < span class = "o" > *< / span > < span class = "k" > FROM< / span > < span class = "n" > contacts< / span > < span class = "p" > )< / span > < span class = "n" > LOOP< / span >
< span class = "k" > FOR< / span > < span class = "n" > c3< / span > < span class = "k" > IN< / span > < span class = "p" > (< / span > < span class = "k" > SELECT< / span > < span class = "o" > *< / span > < span class = "k" > FROM< / span > < span class = "n" > parties< / span > < span class = "p" > )< / span > < span class = "n" > LOOP< / span >
< span class = "k" > NULL< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "n" > LOOP< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "n" > LOOP< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "n" > LOOP< / span > < span class = "p" > ;< / span >
< span class = "k" > END< / span > < span class = "p" > ;< / span >
< span class = "o" > /< / span >
< / code > < / pre > < / div > < / div >
< p > < strong > This rule has the following properties:< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Default Value< / th >
< th > Description< / th >
< th > Multivalued< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > allowSimpleLoops< / td >
< td > false< / td >
< td > Ignore simple loops, that are not nested< / td >
< td > no< / td >
< / tr >
< tr >
< td > cursorPattern< / td >
< td > [a-zA-Z_0-9]{5,}< / td >
< td > The pattern used for the curosr loop variable< / td >
< td > no< / td >
< / tr >
< tr >
< td > indexPattern< / td >
< td > [a-zA-Z_0-9]{5,}< / td >
< td > The pattern used for the index loop variable< / td >
< td > no< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Use this rule with the default properties by just referencing it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/ForLoopNaming"< / span > < span class = "nt" > /> < / span >
< / code > < / pre > < / div > < / div >
< p > < strong > Use this rule and customize it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/ForLoopNaming"< / span > < span class = "nt" > > < / span >
< span class = "nt" > < properties> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > "allowSimpleLoops"< / span > < span class = "na" > value=< / span > < span class = "s" > "false"< / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > "cursorPattern"< / span > < span class = "na" > value=< / span > < span class = "s" > "[a-zA-Z_0-9]{5,}"< / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > "indexPattern"< / span > < span class = "na" > value=< / span > < span class = "s" > "[a-zA-Z_0-9]{5,}"< / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /properties> < / span >
< span class = "nt" > < /rule> < / span >
< / code > < / pre > < / div > < / div >
< h2 id = "linelength" > LineLength< / h2 >
< p > < strong > Since:< / strong > PMD 6.13.0< / p >
< p > < strong > Priority:< / strong > Medium (3)< / p >
< p > This rule checks for long lines. Please note that comments are not ignored.< / p >
< p > This rule is the PMD equivalent of checkstyle’ < a href = "http://checkstyle.sourceforge.net/config_sizes.html#LineLength" > LineLength< / a > check.< / p >
< p > < strong > This rule is defined by the following Java class:< / strong > < a href = "https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codestyle/LineLengthRule.java" > net.sourceforge.pmd.lang.plsql.rule.codestyle.LineLengthRule< / a > < / p >
< p > < strong > This rule has the following properties:< / strong > < / p >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Default Value< / th >
< th > Description< / th >
< th > Multivalued< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > maxLineLength< / td >
< td > 80< / td >
< td > The maximum allowed line length< / td >
< td > no< / td >
< / tr >
< tr >
< td > eachLine< / td >
< td > false< / td >
< td > Whether to report each line that is longer only the first line< / td >
< td > no< / td >
< / tr >
< / tbody >
< / table >
< p > < strong > Use this rule with the default properties by just referencing it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/LineLength"< / span > < span class = "nt" > /> < / span >
< / code > < / pre > < / div > < / div >
< p > < strong > Use this rule and customize it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/LineLength"< / span > < span class = "nt" > > < / span >
< span class = "nt" > < properties> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > "maxLineLength"< / span > < span class = "na" > value=< / span > < span class = "s" > "80"< / span > < span class = "nt" > /> < / span >
< span class = "nt" > < property< / span > < span class = "na" > name=< / span > < span class = "s" > "eachLine"< / span > < span class = "na" > value=< / span > < span class = "s" > "false"< / span > < span class = "nt" > /> < / span >
< span class = "nt" > < /properties> < / span >
< span class = "nt" > < /rule> < / span >
< / code > < / pre > < / div > < / div >
< h2 id = "misplacedpragma" > MisplacedPragma< / h2 >
< p > < strong > Since:< / strong > PMD 5.5.2< / p >
< p > < strong > Priority:< / strong > Medium (3)< / p >
< p > Oracle states that the PRAQMA AUTONOMOUS_TRANSACTION must be in the declaration block,
but the code does not complain, when being compiled on the 11g DB.
https://docs.oracle.com/cd/B28359_01/appdev.111/b28370/static.htm#BABIIHBJ< / p >
< p > < strong > This rule is defined by the following XPath expression:< / strong > < / p >
< div class = "language-xpath highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "o" > //< / span > < span class = "nt" > ProgramUnit< / span > < span class = "o" > /< / span > < span class = "nt" > Pragma< / span > < span class = "w" >
< / span > < / code > < / pre > < / div > < / div >
< p > < strong > Example(s):< / strong > < / p >
< div class = "language-sql highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "k" > create< / span > < span class = "k" > or< / span > < span class = "k" > replace< / span > < span class = "n" > package< / span > < span class = "n" > inline_pragma_error< / span > < span class = "k" > is< / span >
< span class = "k" > end< / span > < span class = "p" > ;< / span >
< span class = "o" > /< / span >
< span class = "k" > create< / span > < span class = "k" > or< / span > < span class = "k" > replace< / span > < span class = "n" > package< / span > < span class = "n" > body< / span > < span class = "n" > inline_pragma_error< / span > < span class = "k" > is< / span >
< span class = "k" > procedure< / span > < span class = "n" > do_transaction< / span > < span class = "p" > (< / span > < span class = "n" > p_input_token< / span > < span class = "k" > in< / span > < span class = "nb" > varchar< / span > < span class = "p" > (< / span > < span class = "mi" > 200< / span > < span class = "p" > ))< / span > < span class = "k" > is< / span >
< span class = "n" > PRAGMA< / span > < span class = "n" > AUTONOMOUS_TRANSACTION< / span > < span class = "p" > ;< / span > < span class = "cm" > /* this is correct place for PRAGMA */< / span >
< span class = "k" > begin< / span >
< span class = "n" > PRAGMA< / span > < span class = "n" > AUTONOMOUS_TRANSACTION< / span > < span class = "p" > ;< / span > < span class = "cm" > /* this is the wrong place for PRAGMA -> violation */< / span >
< span class = "cm" > /* do something */< / span >
< span class = "k" > COMMIT< / span > < span class = "p" > ;< / span >
< span class = "k" > end< / span > < span class = "n" > do_transaction< / span > < span class = "p" > ;< / span >
< span class = "k" > end< / span > < span class = "n" > inline_pragma_error< / span > < span class = "p" > ;< / span >
< span class = "o" > /< / span >
< / code > < / pre > < / div > < / div >
< p > < strong > Use this rule by referencing it:< / strong > < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < rule< / span > < span class = "na" > ref=< / span > < span class = "s" > "category/plsql/codestyle.xml/MisplacedPragma"< / span > < span class = "nt" > /> < / span >
< / code > < / pre > < / div > < / div >
< div class = "tags" >
< / div >
< / div >
< footer >
2022-03-24 11:42:13 +00:00
< hr / >
< div >
This documentation is written in markdown. < br / >
If there is something missing or can be improved, edit this page on
github and create a PR:
< a
target="_blank"
href="https://github.com/pmd/pmd/blob/master/docs/../pmd-plsql/src/main/resources/category/plsql/codestyle.xml"
role="button"
>< i class = "fa fa-github fa-lg" > < / i > Edit on GitHub< /a
>
< / div >
< hr / >
< div class = "row" >
< div class = "col-lg-12 footer" >
© 2022 PMD Open Source Project. All rights
reserved. < br / >
2022-09-11 09:48:57 +00:00
Site last generated: Sep 11, 2022 < br / >
2022-03-24 11:42:13 +00:00
< p >
< img src = "images/pmd-logo-small.png" alt = "Company
logo"/>
< / p >
< / div >
< / div >
2020-11-14 09:20:07 +00:00
< / footer >
2022-02-25 09:51:51 +00:00
< / div >
<!-- /.row -->
2020-11-14 09:20:07 +00:00
< / div >
2022-02-25 09:51:51 +00:00
<!-- /.container -->
< / div >
<!-- Sticky TOC column -->
< div class = "toc-col" >
2022-03-24 11:42:13 +00:00
< div id = "toc" > < / div >
2020-11-14 09:20:07 +00:00
< / div >
2022-02-25 09:51:51 +00:00
<!-- /.toc - container - wrapper -->
2020-11-14 09:20:07 +00:00
< / div >
< / div >
< / body >
< / html >
