Chef/Style/CommentFormat
The Cookstyle cops department: Chef/Style
| Enabled by default | Supports autocorrection | Target Chef Version |
|---|---|---|
| Enabled | Yes | All Versions |
Checks for incorrectly formatted headers
Examples
# bad
Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Recipe default.rb
Attributes default.rb
License Apache2
Cookbook tomcat
Cookbook Name:: Tomcat
Attributes File:: default
# good
Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Recipe:: default.rb
Attributes:: default.rb
License:: Apache License, Version 2.0
Cookbook:: Tomcat
Configurable attributes
| Name | Default value | Configurable values |
|---|---|---|
| Version Added | 5.0.0 | String |
| Include | Array |