go - 如何在 Go 中将代码标记为已弃用？

Question

在 Go 中，如何将代码标记为已弃用，以便用户在使用时收到警告？

Answer 1

Godoc: documenting Go code这是关于将代码标记为已弃用的:

To signal that an identifier should not be used, add a paragraph to its doc comment that begins with "Deprecated:" followed by some information about the deprecation.

这是一个语法示例(查看更多 here):

// Title treats s as UTF-8-encoded bytes and returns a copy with all Unicode letters that begin
// words mapped to their title case.                                                            
//                                                                         
// Deprecated: The rule Title uses for word boundaries does not handle Unicode              
// punctuation properly. Use golang.org/x/text/cases instead.                 
func Title(s []byte) []byte {  
    ⋮
}
                               

文档站点 pkg.go.dev在单击“显示”按钮后隐藏已弃用标识符的文档。

staticcheck工具报告使用了已弃用的标识符(请参阅 SA1019)。

Goland IDE code inspector报告使用了已弃用的标识符。