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.
| CodeSonar® 9.0p0 Hot Tips | CONFIDENTIAL | CodeSecure Inc |
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.
This warning class corresponds to a Staticcheck check: "The documentation of an exported function should start with the function's name".
For full check details, see the Staticcheck website: ST1020 - The documentation of an exported function should start with the function's name.
| Class Name | The Documentation of an Exported Function Should Start With the Function's Name (Staticcheck) | |||
|---|---|---|---|---|
| Significance | style | |||
| Mnemonic | GO.STYLE.TDOAEF | |||
| Categories |
|
|||
| 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 Function Should Start With the Function's Name (Staticcheck)" |
The following configuration file parameters affect checks for this warning class.
Japanese (ja)