Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="wysiwyg-macro" data-macro-name="unmigrated-inline-wiki-markup" data-macro-parameters="atlassian-macro-output-type=BLOCK" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3VubWlncmF0ZWQtaW5saW5lLXdpa2ktbWFya3VwOmF0bGFzc2lhbi1tYWNyby1vdXRwdXQtdHlwZT1CTE9DS30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>{iframe:src=http://update.sonarsource.org/plugins/taglist.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table>

<h2>Description / Features</h2>

<p>This Taglist Sonar plugin handles Checkstyle ToDoComment rule and <a href="http://jira.codehaus.org/browse/SONAR-1817">Squid NoSonar rule</a>  and generates a report on various tags found in the code, like <code>@todo</code> or <code>//TODO</code> tags.</p>

<p>The reporting part is done by a widget that shows total number of tags found and a repartition. A split is done between mandatory and optional tags. Mandatory tags are tags that have been defined with a CRITICAL or BLOCKER priority when activating the rule, optional are the ones with MAJOR, MINOR or INFO priority.</p>

<h2>Usage &amp; Installation</h2>

<ul>
	<li>Stop Sonar Web server</li>
	<li>Place the jar into the /extensions/plugins directory</li>
	<li>Restart Sonar Web server</li>
	<li>Define the tags you want to hunt by creation of a new rules from &quot;Checkstyle Comment pattern matcher&quot; and activation in your quality profile :<br />
<img class="confluence-embedded-image confluence-content-image-border" src="/download/attachments/230400666/taglist_todo_comment_rule.png?version=1&amp;modificationDate=1368913659978" data-image-src="/download/attachments/230400666/taglist_todo_comment_rule.png?version=1&amp;modificationDate=1368913659978" data-linked-resource-id="230564990" data-linked-resource-type="attachment" data-linked-resource-default-alias="taglist_todo_comment_rule.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400666" title="null > taglist_todo_comment_rule.png"></li>
	<li>Also you can enable NoSonar rule :<br />
<img class="confluence-embedded-image confluence-content-image-border" src="/download/attachments/230400666/taglist_nosonar_rule.png?version=1&amp;modificationDate=1368913659978" data-image-src="/download/attachments/230400666/taglist_nosonar_rule.png?version=1&amp;modificationDate=1368913659978" data-linked-resource-id="230564989" data-linked-resource-type="attachment" data-linked-resource-default-alias="taglist_nosonar_rule.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400666" title="null > taglist_nosonar_rule.png"></li>
	<li>Launch a new analysis and you'll get such kind of reports :<br />
<img class="confluence-embedded-image confluence-content-image-border" src="/download/attachments/230400666/taglist_widget.png?version=1&amp;modificationDate=1368913659966" data-image-src="/download/attachments/230400666/taglist_widget.png?version=1&amp;modificationDate=1368913659966" data-linked-resource-id="230564988" data-linked-resource-type="attachment" data-linked-resource-default-alias="taglist_widget.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400666" title="null > taglist_widget.png"><br />
<img class="confluence-embedded-image confluence-content-image-border" src="/download/attachments/230400666/taglist_violations.png?version=1&amp;modificationDate=1368913659979" data-image-src="/download/attachments/230400666/taglist_violations.png?version=1&amp;modificationDate=1368913659979" data-linked-resource-id="230564991" data-linked-resource-type="attachment" data-linked-resource-default-alias="taglist_violations.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="230400666" title="null > taglist_violations.png"></li>
</ul>

<table class="wysiwyg-macro" data-macro-name="note" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vdGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">
<p>File <code>/extensions/plugins/taglist/taglist.properties</code> not used since version 1.0.</p></td></tr></table>

<h2>Known problems</h2>

<p>NullPointerException when CheckStyle rule has default value - see <a href="http://jira.codehaus.org/browse/SONARPLUGINS-925">SONARPLUGINS-925</a>.</p>

<h2>Changelog</h2>