控制台输出格式

Question

是否存在从命令行应用程序格式化控制台输出以获得可读性和一致性的约定？例如，你是否缩进子信息，何时打印空行，如果有的话，你应该如何重视这些重要的陈述。

我发现输出很快就会退化成混乱的模糊。我很想知道其他人做了什么。

更新：实际上这适用于将调试状态从终端中调出的嵌入式软件，但它非常像一个控制台应用程序，我想每个人都会更熟悉它。谢谢到目前为止。

Answer 1

我区分了两种程序：

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

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

我的建议：

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

Answer 2

如果这是针对* nix环境，那么我建议您阅读Basics of Unix Philosophy。它并不特定于输出，但一般来说命令行程序有一些很好的指导。

  

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