做个网站需要什么设备,中煤矿山建设集团网站,深圳seo网站推广报价,在网站建设中什么用于搭建页面结构checkstyle是提高代码质量,检查代码规范的很好用的一款工具#xff0c;本文简单介绍一下集成的步骤#xff0c;并提供一份完整的checkstyle的代码规范格式文件#xff0c;以及常见的格式问题的解决方法。
一#xff0c;安装
打开idea的文件选项#xff0c;选择设置…
checkstyle是提高代码质量,检查代码规范的很好用的一款工具本文简单介绍一下集成的步骤并提供一份完整的checkstyle的代码规范格式文件以及常见的格式问题的解决方法。
一安装
打开idea的文件选项选择设置进入后选择插件搜索checkstyle,安装安装后重启idea。 二格式文件
在项目的根目录下新建checkstyle.xml文件 ?xml version1.0?
!DOCTYPE module PUBLIC-//Checkstyle//DTD Checkstyle Configuration 1.3//ENhttps://checkstyle.org/dtds/configuration_1_3.dtd!--Checkstyle configuration that checks the Google coding conventions from Google Java Stylethat can be found at https://google.github.io/styleguide/javaguide.htmlCheckstyle is very configurable. Be sure to read the documentation athttp://checkstyle.org (or in your downloaded distribution).To completely disable a check, just comment it out or delete it from the file.To suppress certain violations please review suppression filters.Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.--module nameCheckermodule nameSuppressWarningsFilter/property namecharset valueUTF-8/property nameseverity valuewarning/property namefileExtensions valuejava, properties, xml/!-- Excludes all module-info.java files --!-- See https://checkstyle.org/filefilters/index.html --module nameBeforeExecutionExclusionFileFilterproperty namefileNamePattern valuemodule\-info\.java$//module!-- https://checkstyle.org/filters/suppressionfilter.html --module nameSuppressionFilterproperty namefile value${org.checkstyle.google.suppressionfilter.config}defaultcheckstyle-suppressions.xml/property nameoptional valuetrue//module!-- Checks for whitespace --!-- See http://checkstyle.org/checks/whitespace/index.html --module nameFileTabCharacterproperty nameeachLine valuetrue//modulemodule nameLineLengthproperty namefileExtensions valuejava/property namemax value100/property nameignorePattern value^package.*|^import.*|a href|href|http://|https://|ftp:////modulemodule nameTreeWalkermodule nameOuterTypeFilename/module nameIllegalTokenTextproperty nametokens valueSTRING_LITERAL, CHAR_LITERAL/property nameformatvalue\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)/property namemessagevalueConsider using special escape sequence instead of octal value or Unicode escaped value.//modulemodule nameAvoidEscapedUnicodeCharactersproperty nameallowEscapesForControlCharacters valuetrue/property nameallowByTailComment valuetrue/property nameallowNonPrintableEscapes valuetrue//modulemodule nameAvoidStarImport/module nameOneTopLevelClass/module nameNoLineWrapproperty nametokens valuePACKAGE_DEF, IMPORT, STATIC_IMPORT//modulemodule nameEmptyBlockproperty nameoption valueTEXT/property nametokensvalueLITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH//modulemodule nameNeedBracesproperty nametokensvalueLITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE//modulemodule nameLeftCurlyproperty nametokensvalueANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF//modulemodule nameRightCurlyproperty nameid valueRightCurlySame/property nametokensvalueLITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,LITERAL_DO//modulemodule nameRightCurlyproperty nameid valueRightCurlyAlone/property nameoption valuealone/property nametokensvalueCLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,COMPACT_CTOR_DEF, LITERAL_SWITCH//modulemodule nameSuppressionXpathSingleFilter!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 --property nameid valueRightCurlyAlone/property namequery value//RCURLY[parent::SLIST[count(./*)1]or preceding-sibling::*[last()][self::LCURLY]]//modulemodule nameWhitespaceAfterproperty nametokensvalueCOMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE, LITERAL_RETURN,LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, LITERAL_FINALLY, DO_WHILE, ELLIPSIS,LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_CATCH, LAMBDA,LITERAL_YIELD, LITERAL_CASE//modulemodule nameWhitespaceAroundproperty nameallowEmptyConstructors valuetrue/property nameallowEmptyLambdas valuetrue/property nameallowEmptyMethods valuetrue/property nameallowEmptyTypes valuetrue/property nameallowEmptyLoops valuetrue/property nameignoreEnhancedForColon valuefalse/property nametokensvalueASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND/message keyws.notFollowedvalueWhitespaceAround: {0} is not followed by whitespace. Empty blocksmay only be represented as {} when not part of a multi-block statement (4.1.3)/message keyws.notPrecededvalueWhitespaceAround: {0} is not preceded with whitespace.//modulemodule nameOneStatementPerLine/module nameMultipleVariableDeclarations/module nameArrayTypeStyle/module nameMissingSwitchDefault/module nameFallThrough/module nameUpperEll/module nameModifierOrder/module nameEmptyLineSeparatorproperty nametokensvaluePACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,COMPACT_CTOR_DEF/property nameallowNoEmptyLineBetweenFields valuetrue//modulemodule nameSeparatorWrapproperty nameid valueSeparatorWrapDot/property nametokens valueDOT/property nameoption valuenl//modulemodule nameSeparatorWrapproperty nameid valueSeparatorWrapComma/property nametokens valueCOMMA/property nameoption valueEOL//modulemodule nameSeparatorWrap!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 --property nameid valueSeparatorWrapEllipsis/property nametokens valueELLIPSIS/property nameoption valueEOL//modulemodule nameSeparatorWrap!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 --property nameid valueSeparatorWrapArrayDeclarator/property nametokens valueARRAY_DECLARATOR/property nameoption valueEOL//modulemodule nameSeparatorWrapproperty nameid valueSeparatorWrapMethodRef/property nametokens valueMETHOD_REF/property nameoption valuenl//modulemodule namePackageNameproperty nameformat value^[a-z](\.[a-z][a-z0-9]*)*$/message keyname.invalidPatternvaluePackage name {0} must match pattern {1}.//modulemodule nameTypeNameproperty nametokens valueCLASS_DEF, INTERFACE_DEF, ENUM_DEF,ANNOTATION_DEF, RECORD_DEF/message keyname.invalidPatternvalueType name {0} must match pattern {1}.//modulemodule nameMemberNameproperty nameformat value^[a-z][a-z0-9][a-zA-Z0-9]*$/message keyname.invalidPatternvalueMember name {0} must match pattern {1}.//modulemodule nameParameterNameproperty nameformat value^[a-z]([a-z0-9][a-zA-Z0-9]*)?$/message keyname.invalidPatternvalueParameter name {0} must match pattern {1}.//modulemodule nameLambdaParameterNameproperty nameformat value^[a-z]([a-z0-9][a-zA-Z0-9]*)?$/message keyname.invalidPatternvalueLambda parameter name {0} must match pattern {1}.//modulemodule nameCatchParameterNameproperty nameformat value^[a-z]([a-z0-9][a-zA-Z0-9]*)?$/message keyname.invalidPatternvalueCatch parameter name {0} must match pattern {1}.//modulemodule nameLocalVariableNameproperty nameformat value^[a-z]([a-z0-9][a-zA-Z0-9]*)?$/message keyname.invalidPatternvalueLocal variable name {0} must match pattern {1}.//modulemodule namePatternVariableNameproperty nameformat value^[a-z]([a-z0-9][a-zA-Z0-9]*)?$/message keyname.invalidPatternvaluePattern variable name {0} must match pattern {1}.//modulemodule nameClassTypeParameterNameproperty nameformat value(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)/message keyname.invalidPatternvalueClass type name {0} must match pattern {1}.//modulemodule nameRecordComponentNameproperty nameformat value^[a-z]([a-z0-9][a-zA-Z0-9]*)?$/message keyname.invalidPatternvalueRecord component name {0} must match pattern {1}.//modulemodule nameRecordTypeParameterNameproperty nameformat value(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)/message keyname.invalidPatternvalueRecord type name {0} must match pattern {1}.//modulemodule nameMethodTypeParameterNameproperty nameformat value(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)/message keyname.invalidPatternvalueMethod type name {0} must match pattern {1}.//modulemodule nameInterfaceTypeParameterNameproperty nameformat value(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)/message keyname.invalidPatternvalueInterface type name {0} must match pattern {1}.//modulemodule nameNoFinalizer/module nameGenericWhitespacemessage keyws.followedvalueGenericWhitespace {0} is followed by whitespace./message keyws.precededvalueGenericWhitespace {0} is preceded with whitespace./message keyws.illegalFollowvalueGenericWhitespace {0} should followed by whitespace./message keyws.notPrecededvalueGenericWhitespace {0} is not preceded with whitespace.//modulemodule nameIndentationproperty namebasicOffset value4/property namebraceAdjustment value2/property namecaseIndent value2/property namethrowsIndent value4/property namelineWrappingIndentation value4/property namearrayInitIndent value2//modulemodule nameAbbreviationAsWordInNameproperty nameignoreFinal valuefalse/property nameallowedAbbreviationLength value0/property nametokensvalueCLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,RECORD_COMPONENT_DEF//modulemodule nameNoWhitespaceBeforeCaseDefaultColon/module nameOverloadMethodsDeclarationOrder/module nameVariableDeclarationUsageDistance/module nameCustomImportOrderproperty namesortImportsInGroupAlphabetically valuetrue/property nameseparateLineBetweenGroups valuetrue/property namecustomImportOrderRules valueSTATIC###THIRD_PARTY_PACKAGE/property nametokens valueIMPORT, STATIC_IMPORT, PACKAGE_DEF//modulemodule nameMethodParamPadproperty nametokensvalueCTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF//modulemodule nameNoWhitespaceBeforeproperty nametokensvalueCOMMA, SEMI, POST_INC, POST_DEC, DOT,LABELED_STAT, METHOD_REF/property nameallowLineBreaks valuetrue//modulemodule nameParenPadproperty nametokensvalueANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,RECORD_DEF//modulemodule nameOperatorWrapproperty nameoption valueNL/property nametokensvalueBAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,TYPE_EXTENSION_AND //modulemodule nameAnnotationLocationproperty nameid valueAnnotationLocationMostCases/property nametokensvalueCLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,RECORD_DEF, COMPACT_CTOR_DEF//modulemodule nameAnnotationLocationproperty nameid valueAnnotationLocationVariables/property nametokens valueVARIABLE_DEF/property nameallowSamelineMultipleAnnotations valuetrue//modulemodule nameNonEmptyAtclauseDescription/module nameInvalidJavadocPosition/module nameJavadocTagContinuationIndentation/module nameSummaryJavadocproperty nameforbiddenSummaryFragmentsvalue^return the *|^This method returns |^A [{]code [a-zA-Z0-9][}]( is a )//modulemodule nameJavadocParagraph/module nameRequireEmptyLineBeforeBlockTagGroup/module nameAtclauseOrderproperty nametagOrder valueparam, return, throws, deprecated/property nametargetvalueCLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF//modulemodule nameJavadocMethodproperty nameaccessModifiers valuepublic/property nameallowMissingParamTags valuetrue/property nameallowMissingReturnTag valuetrue/property nameallowedAnnotations valueOverride, Test/property nametokens valueMETHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF//modulemodule nameMissingJavadocMethodproperty namescope valuepublic/property nameminLineCount value2/property nameallowedAnnotations valueOverride, Test/property nametokens valueMETHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,COMPACT_CTOR_DEF//modulemodule nameMissingJavadocTypeproperty namescope valueprotected/property nametokensvalueCLASS_DEF, INTERFACE_DEF, ENUM_DEF,RECORD_DEF, ANNOTATION_DEF/property nameexcludeScope valuenothing//modulemodule nameMethodNameproperty nameformat value^[a-z][a-z0-9]\w*$/message keyname.invalidPatternvalueMethod name {0} must match pattern {1}.//modulemodule nameSingleLineJavadoc/module nameEmptyCatchBlockproperty nameexceptionVariableName valueexpected//modulemodule nameCommentsIndentationproperty nametokens valueSINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN//module!-- https://checkstyle.org/filters/suppressionxpathfilter.html --module nameSuppressionXpathFilterproperty namefile value${org.checkstyle.google.suppressionxpathfilter.config}defaultcheckstyle-xpath-suppressions.xml/property nameoptional valuetrue//modulemodule nameSuppressWarningsHolder/module nameSuppressionCommentFilterproperty nameoffCommentFormat valueCHECKSTYLE.OFF\: ([\w\|])/property nameonCommentFormat valueCHECKSTYLE.ON\: ([\w\|])/property namecheckFormat value$1//modulemodule nameSuppressWithNearbyCommentFilterproperty namecommentFormat valueCHECKSTYLE.SUPPRESS\: ([\w\|])/!-- $1 refers to the first match group in the regex defined in commentFormat --property namecheckFormat value$1/!-- The check is suppressed in the next line of code after the comment --property nameinfluenceFormat value1//module/module
/module
三应用检查
1打开设置--》工具--》Checkstyle 2新增一个配置文件并勾上 3运行检查 四常见格式问题的解决方法
1两边加空格 2注释后面加句号 3参数后面加上nonull 4param前面空一行 5if后面要空格 6参数里逗号后有空格 码字不易记得点赞关注哟
