如何从XML文档生成中排除解决方案中的子文件夹? [英] How do I exclude sub-folders in a solution from XML documentation generation?

查看:111
本文介绍了如何从XML文档生成中排除解决方案中的子文件夹?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

Hey Codeproject,



我刚发现你可以为你的解决方案生成XML文档。我想知道是否有可能从生成文档中排除一堆子文件夹?甚至可以排除一个班级吗?



我已经向我的图书馆添加了几个项目,这两个项目都有大量的课程,这使得我的文件非常冗长。



有什么想法吗?



我的尝试:



我已经尝试将自己的课程放在不同的项目中,但这会在不同的对象之间产生歧义问题。



问候,

- Eddie

解决方案

如果可能的话,将这些子文件夹放在一个单独的项目中,你可以在其中禁用项目构建属性下的 XML文档文件

如果使用 SandCastle 生成文档,还可以从中禁用类和命名空间文档,请参阅:在沙堡中排除表单设计器文件 [ ^ ]

我还可以推荐 Sandcastle帮助文件生成器(SHFB),这使得安装SandCastle变得轻而易举: GitHub - EWSoftware / SHFB:Sandcastle帮助文件生成器(SHFB)。 [ ^ ]

Hey Codeproject,

I've only just found out you can generate XML documentation for your solutions. I was wondering if it was possible to exclude a bunch of sub-folders from having documentation generated? Is it even possible to exclude a single class?

I've added several projects to my library, both of which have tons of classes, and this makes the generation of my documentation extremely lengthy.

Any ideas?

What I have tried:

I've already tried putting my own classes in a different project, but this generates ambiguity issues between different objects.

Regards,
- Eddie

解决方案

If possible put those sub folders in a separate project where you can disable the "XML documentation file" under project build properties.
If you use SandCastle to generate the documentation, you can also disable classes and namespaces from the documentation, see: Exclude form designer files in sandcastle[^]
I can also recommend Sandcastle Help File Builder (SHFB), this makes installing SandCastle a piece of cake: GitHub - EWSoftware/SHFB: Sandcastle Help File Builder (SHFB).[^]


这篇关于如何从XML文档生成中排除解决方案中的子文件夹?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆