Go自定义字符串切片Flag的Help输出中“value”字样的来源及移除方法

你看到的帮助信息里的"value"，是Go标准库flag包的默认行为：当你用flag.Var()注册自定义Flag类型时，如果你的类型只实现了基础的flag.Value接口（也就是String()和Set()方法），flag包无法自动识别这个Flag的参数类型名称，所以就会用默认的"value"作为参数占位符显示在帮助里。

怎么替换这个"value"？ #

要自定义这个占位符的内容，只需要给你的strSliceFlag类型额外实现一个Type() string方法就行——这个方法是flag包内部隐式依赖的接口，返回的字符串会被用作帮助信息里的参数占位符。

修改后的完整代码示例：

import "fmt"
import "flag"

type strSliceFlag []string

func (i *strSliceFlag) String() string {
    return fmt.Sprint(*i)
}

func (i *strSliceFlag) Set(value string) error {
    *i = append(*i, value)
    return nil
}

// 添加这个Type方法，自定义参数占位符内容
func (i *strSliceFlag) Type() string {
    return "string" // 你也可以改成更贴合的名称，比如"strslice"
}

func main() {
    tFlagExpl := "Test explanation"
    var tags strSliceFlag
    flag.Var(&tags, "t", tFlagExpl)
    flag.Parse()
}

重新编译后执行main -h，帮助信息就会变成：

Usage of main:
-t string
Test explanation

能不能完全移除这个占位符？ #

这很难做到——因为flag包的帮助输出逻辑中，所有需要接收参数的Flag（也就是实现了flag.Value的Flag）都会显示参数占位符。如果强行返回空字符串，会显示成-t （后面带空格），反而影响美观。建议还是用有意义的类型名称替换默认的"value"，这样用户能更清楚这个Flag需要接收什么类型的参数。

内容的提问来源于stack exchange，提问作者テッド