编写文档 - 用于在线显示文档的开源解决方案?

发布于 2024-11-16 03:15:35 字数 1539 浏览 1 评论 0原文

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

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

发布评论

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

评论(1

眼眸里的那抹悲凉 2024-11-23 03:15:35

Adobe 有一个名为 ASDoc 的免费工具。它生成遵循 Adob​​e 官方模式的文档。坦率地说,这并不值得。 ASDoc 工具存在缺陷且不可靠。如果它很难找到导入,如果未使用导入,注释格式不正确,或者您的源代码以任何意外的方式散布,它就会崩溃。

为了绕过这些限制和我们的解决方案,我的公司已经损失了 50 多个开发时间(一些人试图让几个不同的项目正常工作但失败了)?我们使用 NaturalDocs (JavaDoc 编译器)。完美吗?不是。它的输出与 ASDoc 相当吗?某种程度上,它并不那么整洁,如果它以不同的方式处理事情就好了,但它可以显示文档。

Adobe has a free tool called ASDoc. It generates documentation which follows the official Adobe patter. Frankly, it isn't worth it though. The ASDoc tool is buggy and unreliable. If it has difficulty finding an import, if an import isn't used, a comment is not correctly formatted, or you have your source code spread out in any sort of unexpected way, it simply breaks.

My company has lost over 50 developer hours (a few people tried to get a couple of different projects to work and failed) in an attempt to get around these limitations and our solution? We used NaturalDocs (A JavaDoc compiler). Is it perfect? No. Is it comparable to ASDoc in output? Sort of, it isn't as neat, and it would be nice if it treated things a little differently, but it works to display the documentation.

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