在Go中,如何将代码标记为已弃用,以便用户在使用时收到警告?
答案 0 :(得分:42)
Godoc: documenting Go code说明了将代码标记为已弃用:
要表示不应使用标识符,请在其文档注释中添加一个段落,该段落以"不推荐使用:"然后是关于弃用的一些信息。
有一个golint issue for reporting use of deprecated identifiers和一个godoc issue用于浏览或隐藏已弃用的标识符。
staticcheck工具报告使用已弃用的标识符(请参阅SA1019)。
答案 1 :(得分:2)
Go编译器不报告警告,只报告阻止的错误 汇编
答案 2 :(得分:1)
Go编译器不支持此功能(5g / 6g / 8g和gccgo都不支持。)
据我所知,目前没有代码检查工具。
唯一的方法是将弃用警告放在文档中,或者只是删除代码。
答案 3 :(得分:0)
将此注释添加到您的函数/结构中 //不推荐使用:FunctionName不推荐使用。
答案 4 :(得分:-3)
你可以创建一个名为old/yourpackage
的包,并建议使用它,如果有人依赖于已弃用的功能/接口,然后创建一个没有旧东西的更新包yourpackage
。
根据Godoc: documenting Go code博客帖子的说法,没有办法以文件中的其他方式插入任何警告或标记方法,因为这些文章说明了:
要表示不应使用标识符,请在其文档注释中添加一个段落,该段落以“已弃用:”开头,后跟一些有关弃用的信息。 standard library中有几个例子。
答案 5 :(得分:-3)
你也可以打印一行到stdout / stderr说“这个方法已被弃用!”每次调用已弃用的方法时。您还可以提供有关用户应如何纠正此问题的提示。