public class SummaryJavadocCheck extends AbstractJavadocCheck
Checks that
Javadoc summary sentence does not contain phrases that are not recommended to use.
Summaries that contain only the {@inheritDoc} tag are skipped.
Check also violate Javadoc that does not contain first sentence.
violateExecutionOnNonTightHtml - Control when to print violations
if the Javadoc being examined by this check violates the tight html rules defined at
Tight-HTML Rules.
Type is boolean.
Default value is false.
forbiddenSummaryFragments - Specify the regexp for forbidden summary fragments.
Type is java.util.regex.Pattern.
Default value is "^$" (empty).
period - Specify the period symbol at the end of first javadoc sentence.
Type is java.lang.String.
Default value is ".".
By default Check validate that first sentence is not empty and first sentence is not missing:
<module name="SummaryJavadocCheck"/>
Example of {@inheritDoc} without summary.
public class Test extends Exception {
//Valid
/**
* {@inheritDoc}
*/
public String ValidFunction(){
return "";
}
//Violation
/**
*
*/
public String InvalidFunction(){
return "";
}
}
To ensure that summary do not contain phrase like "This method returns", use following config:
<module name="SummaryJavadocCheck">
<property name="forbiddenSummaryFragments"
value="^This method returns.*"/>
</module>
To specify period symbol at the end of first javadoc sentence:
<module name="SummaryJavadocCheck"> <property name="period" value="。"/> </module>
Example of period property.
public class TestClass {
/**
* This is invalid java doc.
*/
void invalidJavaDocMethod() {
}
/**
* This is valid java doc。
*/
void validJavaDocMethod() {
}
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
javadoc.missed.html.close
javadoc.parse.rule.error
javadoc.wrong.singleton.html.tag
summary.first.sentence
summary.javaDoc
summary.javaDoc.missing
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static String |
MSG_SUMMARY_FIRST_SENTENCE
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_SUMMARY_JAVADOC
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_SUMMARY_JAVADOC_MISSING
A key is pointing to the warning message text in "messages.properties"
file.
|
MSG_JAVADOC_MISSED_HTML_CLOSE, MSG_JAVADOC_PARSE_RULE_ERROR, MSG_JAVADOC_WRONG_SINGLETON_TAG| Constructor and Description |
|---|
SummaryJavadocCheck() |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getDefaultJavadocTokens()
Returns the default javadoc token types a check is interested in.
|
int[] |
getRequiredJavadocTokens()
The javadoc tokens that this check must be registered for.
|
void |
setForbiddenSummaryFragments(Pattern pattern)
Setter to specify the regexp for forbidden summary fragments.
|
void |
setPeriod(String period)
Setter to specify the period symbol at the end of first javadoc sentence.
|
void |
visitJavadocToken(DetailNode ast)
Called to process a Javadoc token.
|
acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, destroy, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, setViolateExecutionOnNonTightHtml, visitTokenclearMessages, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final String MSG_SUMMARY_FIRST_SENTENCE
public static final String MSG_SUMMARY_JAVADOC
public static final String MSG_SUMMARY_JAVADOC_MISSING
public SummaryJavadocCheck()
public void setForbiddenSummaryFragments(Pattern pattern)
pattern - a pattern.public void setPeriod(String period)
period - period's value.public int[] getDefaultJavadocTokens()
AbstractJavadocCheckgetDefaultJavadocTokens in class AbstractJavadocCheckJavadocTokenTypespublic int[] getRequiredJavadocTokens()
AbstractJavadocCheckgetRequiredJavadocTokens in class AbstractJavadocCheckJavadocTokenTypespublic void visitJavadocToken(DetailNode ast)
AbstractJavadocCheckvisitJavadocToken in class AbstractJavadocCheckast - the token to processCopyright © 2001–2020. All rights reserved.