控制台输出格式

发布于 2024-07-11 20:22:10 字数 217 浏览 4 评论 0原文

是否有任何约定来格式化命令行应用程序的控制台输出以提高可读性和一致性? 例如,您是否缩进子信息,何时打印空行,如果有的话,您应该如何强调重要的陈述。

我发现输出很快就会变得混乱而模糊。 我有兴趣听听其他人在做什么。

更新:实际上,这是针对嵌入式软件的,它可以将调试状态输出到终端,但它非常像控制台应用程序,我认为每个人都会更熟悉这一点。 到目前为止谢谢。

Are there any conventions for formatting console output from a command line app for readability and consistency? For instance, do you indent sub-information, when do you print a blank line, if ever, how should you accent important statements.

I've found output can quickly degenerate into a chaotic blur. I'm interested in hearing about what other people do.

Update: Really this is for embedded software which spits debug status out a terminal, but it's pretty much like a console app, and I figured everyone would be more familiar with that. Thanks so far.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

巷子口的你 2024-07-18 20:22:10

我会区分两种类型的程序:

您是否打印脚本可能使用的信息(即它应该是可解析的)? 然后定义一个相当严格的格式并仅使用该格式(例如固定字段分隔符)。

您是否打印不需要由脚本解析的信息(或者是否已经有替代的脚本可解析格式)? 然后写出自然的内容:

我的建议:

  • 这样写,以便您能够阅读它
  • ,将子信息缩进 2 或 4 个空格,绝对不要将更多
  • 单独的信息块最多分隔一个空行,尊重
  • COLUMN 环境变量(以及可能的ROWS,如果它适用于您的输出)。

I'd differentiate two kinds of programs:

Do you print information that might be used by a script (i.e. it should be parseable)? Then define a pretty strict format and use only that (for example fixed field separators).

Do you print information that need not be parsed by a script (or is there an alternative script-parseable format already)? Then write what comes natural:

My suggestions:

  • write it so that you would like to read it
  • indent sub-information 2 or 4 spaces, definitely not more
  • separate blocks of information by one empty line at most
  • respect the COLUMN environment variable (and possible ROWS if it applies to your output).
ぃ双果 2024-07-18 20:22:10

如果这是针对 *nix 环境,那么我建议阅读 Unix 哲学基础< /a>. 它并不特定于输出,但对于一般的命令行程序有一些很好的指南。

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

If this is for a *nix environment, then I'd recommend reading Basics of Unix Philosophy. It's not specific to output but there are some good guidelines for command line programs in general.

Expect the output of every program to become the input to another, as yet unknown, program. Don't clutter output with extraneous information. Avoid stringently columnar or binary input formats. Don't insist on interactive input.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文