stdout - 控制台输出格式

Question

为了可读性和一致性，是否有任何用于格式化命令行应用程序控制台输出的约定？例如，你是否缩进子信息，你什么时候打印一个空行，如果有的话，你应该如何强调重要的陈述。

我发现输出会迅速退化为混乱的模糊。我有兴趣了解其他人的做法。

更新：这确实是用于将调试状态吐出终端的嵌入式软件，但它很像控制台应用程序，我想每个人都会更熟悉它。感谢到目前为止。

Answer 1

如果这是针对 *nix 环境的，那么我建议您阅读Basics of Unix Philosophy。它不是特定于输出的，但通常有一些关于命令行程序的良好指南。

期望每个程序的输出成为另一个未知程序的输入。不要用无关信息使输出混乱。避免严格的列式或二进制输入格式。不要坚持交互式输入。

Answer 2

我会区分两种程序：

您是否打印脚本可能使用的信息（即它应该是可解析的）？然后定义一个非常严格的格式并只使用它（例如固定字段分隔符）。

您是否打印不需要由脚本解析的信息（或者是否已经有替代的脚本可解析格式）？然后写自然的东西：

我的建议：

• 写出来让你想读
• 缩进子信息 2 或 4 个空格，绝对不会更多
• 最多用一个空行分隔信息块
• 尊重COLUMN环境变量（ROWS如果它适用于您的输出，则可能）。