cake-build/cake
在 GitHub 查看Provide ability to create documentation for Arguments similar to Tasks
Open
#1,708 创建于 2017年7月31日
FeatureHelp wantedUp-for-grabs
仓库指标
- Star
- (3,742 star)
- PR 合并指标
- (平均合并 1天 1小时) (30 天内合并 25 个 PR)
描述
Hi,
as described in this SO question: https://stackoverflow.com/questions/45413524/how-can-cake-build-arguments-be-documented
it would be great to be able to add documentation for Arguments as it is currently possible for Tasks by using the Description("...") method.
So e.g. executing the build script with the -showdescription parameter could show the described targets as well as the available arguments with an optional help text:
For registering a help text with an argument an additional parameter could be introduced to the already existing Argument methods. E.g.
Argument("someArgument", "x", "Argument description. Can be multiline, maybe.")
Or some other way:
var argValue = ArgumentBuilder("someArgument", "x")
.WithHelpText("Argument description. Can be multiline, maybe.")
.GetValue()
What do you think?
Best regards, Philipp