我正在编写一个控制台应用程序,它正在迅速获得许多命令行参数和标志。出于这个原因,我希望用户能够访问这些标志的描述以及它们的用途。
我能想到几种可能的解决方案
- 我可以编写一个 README 文件并将其粘贴在与可执行文件相同的目录中。优点是简单且可移植,但缺点是有人很容易删除/编辑文件。
我可以将整个消息粘贴在程序中的一个变量中,并在用户键入
mycmd --help
或类似内容时将其打印到屏幕上。优点,保留可执行且不可编辑,缺点在于代码,因为我会在下面浮动类似的东西。const char[] helpmsg = "Line1\n" "Line2\n" "...\n" "LineN\n";
我可以为我的程序编写一个
man
条目,但这不是很便携,因为该应用程序在 Windows 和 Linux 上的使用几乎相同。
我知道这个问题可能是一个品味问题,但我只是好奇是否还有其他我没有想到的人们过去使用过的解决方案。
理想情况下,这对开发人员(目前是我)来说很容易编辑和保持更新,但其他人无法真正搞砸它。