是否有编写手册页的最佳实践指南?

布局中应该包含哪些内容?标准的有:

名称
概要
描述
例子
也可以看看

还有其他选项,如 OPTIONS、AUTHOR。

作为用户,拥有什么有用?什么没有帮助?

最佳答案

如果您找不到 1970 年代贝尔实验室“troff”文档的任何旧装订副本,其中有一些关于编写手册页的不错部分,:-) 那么我建议您在他的网站上试用 Jens 的 "HOWTO" on writing man pages

Unix 7th Edition 手册以多种格式在线提供。

关于linux - 放入手册页的最佳实践,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/779975/

10-13 07:50