GO.STYLE.TDOAEV : The Documentation of an Exported Variable or Constant Should Start With Variable's Name (Staticcheck)

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

GO.STYLE.TDOAEV : The Documentation of an Exported Variable or Constant Should Start With Variable's Name (Staticcheck)

This warning class corresponds to a Staticcheck check. The CodeSonar analysis results may include warnings of this class if your CodeSonar project includes Go components.

Summary

This warning class corresponds to a Staticcheck check: "The documentation of an exported variable or constant should start with variable's name".

For full check details, see the Staticcheck website: ST1022 - The documentation of an exported variable or constant should start with variable's name.

Properties

Class Name

The Documentation of an Exported Variable or Constant Should Start With Variable's Name (Staticcheck)

Significance

style

Mnemonic

GO.STYLE.TDOAEV

Categories

Staticcheck	Staticcheck:ST1022	The documentation of an exported variable or constant should start with variable's name

Availability

Available for Go only.

Enabling

Checking for this warning class is performed by the third party Staticcheck analyzer, with the results imported into the CodeSonar project.

To enable or disable checking, you will need to adjust your adjust your Staticcheck configuration.

If the checker produces one or more results corresponding to this warning class, they will be submitted to the hub by default. To disable submission, add the following WARNING_FILTER rule to the project configuration file.

WARNING_FILTER += discard class="The Documentation of an Exported Variable or Constant Should Start With Variable's Name (Staticcheck)"

Relevant Configuration File Parameters

The following configuration file parameters affect checks for this warning class.

To report problems with this documentation, please visit https://support.codesecure.com/.