Slash-asterisk comments


Although the Puppet language allows you to use /* */ style multiline comments, it is recommended that you use multiple # style comments instead (style guide).

What you have done

  /* my awesome comment that describes
   * exactly what I'm trying to do */

What you should have done:

  # my awesome comment that describes
  # exactly what I'm trying to do

Disabling the check

To disable this check you can add --no-star_comments-check to your puppet-lint command line.

$ puppet-lint --no-star_comments-check path/to/file.pp

Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your Rakefile.

PuppetLint.configuration.send('disable_star_comments')