DeepSource
Dashboard Resources Pricing Discover Directory Log in

Run your first analysis.

Find thousands of code security and quality issues in your codebase, before they end up in production.

Start now
Go

Go

By DeepSource

Use Analyzer
The documentation of an exported type should start with the type’s name GO-D5002
Documentation

Doc comments work best as complete sentences, which allow a wide variety of automated presentations. The first sentence should be a one-sentence summary that starts with the name being declared.
Malformed "deprecated" doc comment GO-D4001
Documentation

Using conventional "deprecated" doc comments allows tools such as go doc and gopls to mark the function as deprecated, warning the user about usage of such deprecated functions.
Documentation of an exported function should start with the function’s name GO-D5001
Documentation

Doc comments work best as complete sentences, which allow a wide variety of automated presentations. The first sentence should be a one-sentence summary that starts with the name being declared.
The documentation of an exported variable or constant should start with the variable’s name GO-D5003
Documentation

Doc comments work best as complete sentences, which allow a wide variety of automated presentations. The first sentence should be a one-sentence summary that starts with the name being declared.