GO.STYLE.TDOAET : The Documentation of an Exported Type Should Start With Type'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.

要旨

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

For full check details, see the Staticcheck website: ST1021 - The documentation of an exported type should start with type's name.

プロパティ

クラス名 The Documentation of an Exported Type Should Start With Type's Name (Staticcheck)
日本語クラス名 The Documentation of an Exported Type Should Start With Type's Name (Staticcheck)
クラス分類 スタイル (style)
ニーモニック GO.STYLE.TDOAET
カテゴリー
Staticcheck Staticcheck:ST1021 The documentation of an exported type should start with type's name
対応言語 Go で利用可能です。
有効/無効設定 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 Type Should Start With Type's Name (Staticcheck)"

関連のある設定ファイルパラメータ

設定ファイルの以下のパラメータがこのワーニングクラスのチェックに影響します。