使用xs：annotation的XSD文档构建器 [英] XSD Documentation builder using xs:annotation
问题描述
我有一组BizTalk架构（XSD），使用
I have a set of BizTalk Schemas (XSDs) which are heavily documented using the
xs:annotation
标记进行大量记录。我正在尝试使用Sandcastle HFB作为具有树视图的CHM将此文档提取到业务的数据字典中。当我将BizTalk Schemas项目编译的dll添加到Sandcastle HFB的文档源并尝试构建帮助文件时，我得到的只是一个错误"找不到文档的API"。我不明白这一点 - Sandcastle HFB是否仅适用于班级？这是否适用于当今主要数据交换格式的XSD？
这些模式非常深入，使用嵌入式注释生成文档是完全合理的（通过使用手册）过程）数据字典和模式通常不同步。这家公司迟早会指出这些并开始怀疑数据字典的真实性。
我发现了一个XSD Documenter xsddoc.codeplex.com但不确定它是如何工作的 - 没有操作方法。
任何帮助将不胜感激！
多伦多的BizTalk开发人员
tag. I am trying to extract this documentation into a Data Dictionary for the business using the Sandcastle HFB as a CHM with a tree-view. When I add the BizTalk Schemas project compiled dll to the Documentation Sources of Sandcastle HFB and try to build the help file, all I get is an error "No APIs found to document". I don't understand this - does Sandcastle HFB only work with classes? Doesn't this work with XSDs which are today the primary data exchange format?
The schemas are pretty deep and it makes complete sense to use the embedded annotation to generate the documentation as otherwise (by using a manual process) the Data Dictionary and the Schemas usually get out of synch. The business sooner or later point these out and start to doubt the authenticity of the Data Dictionary.
I found a XSD Documenter xsddoc.codeplex.com but not sure how this works - there is no How-To.
Any help would be appreciated!
BizTalk developer in Toronto
推荐答案
Sandcastle和SHFB仅文档集合但是使用XSD Documentor插件和构建组件，可以使用SHFB记录XSD架构。我记得，XSD Documentor附带了一个帮助文件。请参阅它以获取帮助。如果没有，请尝试直接联系组件的作者。在 http://shobiz.codeplex.com/ 上还有一个与BizTalk相关的插件。这也可能对你有所帮助。
如果你有集会，也许其中的课程是私人的或内部的。尝试启用DocumentInternals和DocumentPrivates项目属性以查看是否有帮助。默认情况下，仅记录公共API。启用这两个属性将记录所有内容，包括私人内容。
左老板
Sandcastle and SHFB only documents assemblies but with the XSD Documentor plug-in and build components it is possible to document XSD schemas with SHFB. As I recall, there is a help file included with the XSD Documentor. Refer to it for help. If not, try contacting the author of the components directly. There's also a plug-in related to BizTalk at http://shobiz.codeplex.com/. That may also help you.
If you do have an assembly, perhaps the classes in it are private or internal. Try enabling the DocumentInternals and DocumentPrivates project properties to see if that helps. By default, only the public APIs are documented. Enabling those two properties will document everything including the private stuff.
Eric
这篇关于使用xs：annotation的XSD文档构建器的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
