沙堡还是 NDoc?一个好的类似 msdn 的文档生成器吗?

发布于 2024-10-07 23:19:09 字数 414 浏览 9 评论 0原文

我一直在困扰自己一个问题:“Javadoc、Doxygen 等等……微软真的有可能没有为其开发人员提供一个好的文档生成器吗?”。这对我来说一直听起来很奇怪...另外因为Msdn是一个非常好的文档排版...我真的比所有其他生成器和文档样式更喜欢它。

不断地困扰自己,我终于决定深入研究这个问题,发现了NDoc和SandCastle的存在。哇,我告诉自己,我终于明白了……看来是这样。好吧,它们是很好的生成器,但我认为微软赞助的官方文档生成器比我之前提到的那两个要多一些。

那么,我想要什么?只需知道微软开发人员使用什么 doc-gen 以类似 msdn 的风格记录他的代码即可。 NDoc 或 Sand Castle 是官方的类似 msdn 的文档生成器吗?经过我的 Microsoft 批准吗? 哪一个最好? 如果不是,我应该使用什么 doc-gen 来以 msdn 风格编写文档?

I've always been bothering myself with a question: "Javadoc, Doxygen and much more.. is it really possible that Microsoft does not provide its developers with a good doc generator?". It has always sounded strange to me... Also because Msdn is a very good documentation typesetting... I really prefer it above all other generators and documentation styles.

Keeping on bothering myself I finally decided to get deeper in this issue and found the existence of NDoc and SandCastle. Wow, I told myself, I finally get it... So it seemed. OK they are good generators but I thought that Microsoft sponsored an official doc gen a bit more than those two I mentioned before.

So, what do I want? Just knowing what doc-gen a microsoft developer uses to document his code in msdn-like style.
Are NDoc or Sand Castle official msdn-like document generator, approved my Microsoft?
Which one is the best?
If they are not, what doc-gen should I use to document in msdn-style?

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

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

发布评论

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

评论(3

删除→记忆 2024-10-14 23:19:09

我们使用DocumentX(以前使用NDoc),我非常喜欢它。他们的许可证检查系统有点麻烦,但程序本身很棒。

We use DocumentX (used to use NDoc) and I like it a lot. Their license check system is a bit of a pain but the program itself is great.

青芜 2024-10-14 23:19:09

SandCastle(带有 GUI)是完全足够的文档生成器。我不认为 MS 会在这方面投入更多精力。

顺便说一句,您可能需要获取 GhostDoc Visual Studio 插件。它大大加快了文档注释的创建速度(只要您正确命名方法和参数等内容,它甚至可以完全生成它们)。

SandCastle (with the GUI) is fully adequate documentation generator. I don't see a reason why MS would put more effort into it.

By the way, you may want to get the GhostDoc Visual Studio plug-in. It speeds up creation of doc comments a lot (it can even generate them completely, as long as you name your methods and parameters and stuff properly).

呆° 2024-10-14 23:19:09

尽管最初的 NDoc 项目几年前就停止了,但还有一个后续项目:NDoc3

Even though the original NDoc project was stopped a few years ago, there is a successor project: NDoc3

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