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.
// deprecated, use Foo instead
func DeprecatedFoo()
// Deprecated: use Foo instead
func DeprecatedFoo()