可打印形式的 C# 类文档

发布于 2024-12-20 08:48:29 字数 1539 浏览 2 评论 0原文

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

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

发布评论

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

评论(3

ˉ厌 2024-12-27 08:48:29

有没有一种基本无痛的方法来做到这一点?

不,不要这样做。对于类级别的文档来说,它毫无意义——没有人会读它。所有超链接都不起作用,必须更改为页面引用。

我们的 C# 源代码使用常用的 Sandcastle/XML 表示法进行了全面记录。

不,事实并非如此。它记录了正常的 XML 文档符号。 Sandcastle 没有发明它。

现在,如果您确实必须这样做:

http://www.innovasys.com/products/dx2011/csdocumentation.aspx?cpid=gawdxcs&gclid=COiJq5To8qwCFQGHDgod900o0g

几乎是您能找到的最好的。他们正是专门从事这一领域的工作(多目标的东西)。它们还处理所需的附加页面等 - 纯类引用,没有索引,只是打印,用超链接而不是页面引用基本上是没有任何意义的树破坏。

Is there a mostly pain-free way to do this?

No, DO not do it. It makes zero sense for a class level documentation - noone will ever read it. TAll hyperlinks do not work, would have to be changed to page references.

Our C# source code is comprehensively documented using the usual Sandcastle/XML notation.

No, it is not. It is documented the normal XML documentation notation. Sandcastle did not invent it.

NOw, if you really have to do it:

http://www.innovasys.com/products/dx2011/csdocumentation.aspx?cpid=gawdxcs&gclid=COiJq5To8qwCFQGHDgod900o0g

is pretty much the best you can get to. The are specialized in exactly that (multi target stuff). They also handle the additional pages etc. which is needed - the pure clas reference, without index, jsut printed, with hyperlinks instead of page references is basically tree destruction without any sense.

心安伴我暖 2024-12-27 08:48:29

显然帮助和手册可以直接导入Sandcastle项目然后以各种格式输出(包括可打印的格式)。

不过我自己还没有尝试过。我很想听听有过这种经历的人的经历。

Apparently Help and Manual can import Sandcastle projects directly and then output them in various formats (including printable ones).

I haven't tried this myself, though. I'd be interested to hear experiences from anyone who has.

蓬勃野心 2024-12-27 08:48:29

Ndoc 有一个 Latex documentor 插件。 NDoc支持Sandcastle支持的所有文档标签,因此应该能够将文档编译成Latex文件。然后,这可以用于创建用于打印的 Postscript 文档等。

Ndoc has a Latex documentor plug-in. NDoc supports all documentation tags supported by Sandcastle, so that should be able to compile the documentation into a Latex file. This can then be used to create, for example, a Postscript document for printing.

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