用于创建 API 文档/提案的平台独立工具

发布于 2024-09-07 05:20:11 字数 1539 浏览 2 评论 0原文

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

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

发布评论

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

评论(1

赤濁 2024-09-14 05:20:11

任何结构化文本语言都可以。我会使用乳胶,而 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.

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