Vale CMS Need more than a rule playground? Explore
Package Explorer

Comments

The comments in code: Go doc comments, Javadoc, and KDoc conventions, plus owned TODOs and no commented-out code in any language Vale extracts comments from.

jdkato/comments 0 stars 8 downloads v0.1.0 · Sep 24, 2026 latest release style Vale ≥ 3.23.0

Getting started

Add it to your .vale.ini, then run vale sync.

Packages = Comments

[*.md]
BasedOnStyles = Vale, Comments

The name installs the latest release each time vale sync runs. To stay on v0.1.0, the release this page describes, give its URL instead:

Packages = https://github.com/jdkato/comments/releases/download/v0.1.0/Comments.zip

Rules 14

2 error10 warning2 suggestion
  • Comments.Code suggestion existence scope: comment

    Commented-out code. Delete it; version control remembers.

  • Comments.Deprecated warning existence scope: comment.go Style guide

    Mark deprecation with a 'Deprecated: ' paragraph, which the tools read.

  • Comments.EmptyTag error existence scope: comment.block.java Style guide

    '%s' says nothing. Describe it, or drop the tag.

  • Comments.EmptyTag error existence scope: comment.block.kt Style guide

    '%s' says nothing. Describe it, or drop the tag.

  • Comments.Markers suggestion substitution scope: comment

    Use 'TODO(name):' instead of '%s', so the note is collected with the rest.

  • Comments.Package warning existence scope: comment.go Style guide

    A package comment reads 'Package name ...'.

  • Comments.Sentence warning existence scope: comment.go Style guide

    A doc comment is a complete sentence: end it with a period.

  • Comments.Summary warning existence scope: comment.block.java Style guide

    The first sentence is the summary the tools show; end it with a period.

  • Comments.Summary warning existence scope: comment.block.kt Style guide

    The first sentence is the summary the tools show; end it with a period.

  • Comments.TagOrder warning existence scope: comment.block.java Style guide

    Order the tags @param, @return, then @throws.

  • Comments.This warning existence scope: comment.block.java Style guide

    Say what it does, not '%s'.

  • Comments.This warning existence scope: comment.go Style guide

    Start with the name it documents, not '%s'.

  • Comments.This warning existence scope: comment.block.kt Style guide

    Say what it does, not '%s'.

  • Comments.Todo warning existence scope: comment Style guide

    '%s' names no owner. Write TODO(name): or TODO(#issue): so it can be followed up.