linux – 放入手册页的最佳实践

概述是否有编写手册页的最佳实践指南？ 什么应该包括在布局中？标准的是： 名称 概要 描述 例子 也可以看看 还有其他像OPTIONS,AUTHOR. 作为一个用户有什么用处？什么没用？ 如果你找不到1970年代贝尔实验室“troff”文档的任何旧版本,其中有一些关于编写手册的好文章,:-)那么我建议在他的网站上试用Jens的 “HOWTO” on writing man pages. Unix 7th 是否有编写手册页的最佳实践指南？

什么应该包括在布局中？标准的是：

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

还有其他像OPTIONS,AUTHOR.

作为一个用户有什么用处？什么没用？

解决方法 如果你找不到1970年代贝尔实验室“troff”文档的任何旧版本,其中有一些关于编写手册的好文章,:-)那么我建议在他的网站上试用Jens的 “HOWTO” on writing man pages.

Unix 7th Edition手册可在线获得各种格式.

总结

以上是内存溢出为你收集整理的linux – 放入手册页的最佳实践全部内容，希望文章能够帮你解决linux – 放入手册页的最佳实践所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。