Go

Go

By DeepSource

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.

Bad practice

// deprecated, use Foo instead
func DeprecatedFoo()

Recommended

// Deprecated: use Foo instead
func DeprecatedFoo()