We don’t allow questions seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
接受
或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
发布评论
评论(1)
任何结构化文本语言都可以。我会使用乳胶,而 troff 是老派。
但您可能错过了使用 doxygen 或其他东西的建议的要点。如果您这样做,那么编写文档也为最终实现奠定了基础。更好的是,示例文档将采用与最终的真实文档相同的格式,并且您当然会对其使用源代码控制,不是吗?因此,您将获得规范更改的详细历史记录。
Any structured text language will do. I'd use latex, and troff is old school.
But you may have missed the point of the suggestion to use doxygen or whatever. If you do that, then writing the documentation is also laying down the scaffold for the eventual implementation. Better still, the example documentation will be in the same format as the eventual real documentation and, you will--of course---use source control on it, won't you? So you'll have a potted history of changes to the spec.