如何在Go中将代码标记为已弃用?

lmyy7pcs  于 2023-04-27  发布在  Go
关注(0)|答案(3)|浏览(318)

在Go中,如何将代码标记为已弃用,以便用户在使用它时获得警告?

w46czmvw

w46czmvw1#

Godoc: documenting Go code是这样说将代码标记为已弃用的:
要表明不应使用标识符,请在其文档注解中添加一个段落,该段落以“Deprecated:”开头,后跟一些关于弃用的信息。
下面是一个语法示例(查看更多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通过单击“show”按钮隐藏了已弃用标识符的文档。
staticcheck工具报告已弃用的标识符的使用情况(参见SA1019)。
Goland IDE代码检查器报告已弃用的标识符的使用。

nzk0hqpo

nzk0hqpo2#

将此注解添加到函数/结构中:

// Deprecated: FunctionName is deprecated.
js81xvg6

js81xvg63#

Go语言编译器中不支持这个功能(5g/6 g/8 g和gccgo都不支持)。
据我所知,目前还没有代码检查工具。
唯一的方法是将弃用警告放在文档中,或者直接删除代码。

相关问题