org.sonar.plugins.web.checks.coding.AvoidHtmlCommentCheck Maven / Gradle / Ivy
/*
* Sonar Web Plugin
* Copyright (C) 2010 Matthijs Galesloot
* [email protected]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.sonar.plugins.web.checks.coding;
import org.sonar.check.IsoCategory;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.plugins.web.checks.AbstractPageCheck;
import org.sonar.plugins.web.node.CommentNode;
import org.sonar.plugins.web.node.DirectiveNode;
import org.sonar.plugins.web.visitor.WebSourceCode;
/**
* Checker for occurrence of html comments.
*
* HTML comment is not allowed in JSP files, use server side comment instead. The check allows HTML comment in XHTML files, recognized by
* its xml declaration.
*
* @author Matthijs Galesloot
* @since 1.0
*/
@Rule(key = "AvoidHtmlCommentCheck", name ="Avoid Html Comment", description = "Avoid Html Comment", priority = Priority.MINOR,
isoCategory = IsoCategory.Efficiency)
public class AvoidHtmlCommentCheck extends AbstractPageCheck {
private boolean xmlDocument;
@Override
public void comment(CommentNode node) {
if ( !xmlDocument && node.isHtml()) {
createViolation(node);
}
}
@Override
public void directive(DirectiveNode node) {
if (node.isXml()) {
xmlDocument = true;
}
}
@Override
public void startDocument(WebSourceCode webSourceCode) {
super.startDocument(webSourceCode);
xmlDocument = false;
}
}