我爱XMLcomments.然而,随着一切都崩溃了,每两行看起来像:[///summary...]publicvoidCreateUser(stringusername,stringpassword)[...]将此乘以数十或数百种方法,所产生的崩溃代码将难以筛选。我能否将这些评论移至单独的XML文件,并且仍然让VisualStudio识别关联以便它们仍然显示在Intellisense中?如果是这样,我如何建立这种联系?我还使用SandCaSTLe生成基于这些评论的文档,因此SandCaSTLe也必须承认该关联。 最佳答案 您可以使用
我有一个wsdl文档,其摘录如下所示...Structureforcustomername我知道xs:element/@name并且我想获取最近的xs:documentation元素。使用上面的示例,我知道xs:element/@name="FullName",并且我想从最近的xs:documentation节点获取文本“Structureforcustomername”!我已经尝试更改我在stackoverflow(和其他站点)上找到的一些示例,但它们都不起作用。典型:0)。干杯。感谢您的回答...希望这会有所帮助...publicstaticstringDecryptStupidC
我已经为我编写的应用程序开发了一个XML模式。现在我想为最终用户记录有效的结构,但是我想不出任何自然的方法来做到这一点。我见过像xs3p这样的东西,它本质上将xsd模式转换为HTML表示,但是对我来说这看起来不像是好的文档;用户不需要了解任何关于模式的知识就可以理解他可以做什么。关于如何记录这个的任何想法?有任何程序/编辑器/图形解决方案或我可以构建的简单概念吗? 最佳答案 我认为最好的方法(经过6年的xsd和设计/编码系统到系统接口(interface)的经验)是使用xsd:documentation和xsd:annotation
关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭4年前。ImprovethisquestionVisualStudio可以做到;Reflector做到了;现在我也想:)我想检索某些框架程序集中某些成员的XML文档(即mscorlib.dll、System.dll等)。我假设这将涉及:找到程序集的XML文件,导航到适当命名的子元素,并且检索所需的项目(、等)框架程序集的XML文件保存在哪里?解密XMLDOC命名方案有什么要点吗?是否有任何库可以简化此过程?
我有一个Web服务,其中定义位于wsdl文件中,架构位于外部xsd文件中。在xsd文件中,有一个schema标签,它提供了一个属性“version”,我可以用它来记录当前版本。wsdl格式(WSDL1.1)中是否有类似的东西?如果不是,为了文档目的存储通用版本属性的最佳位置是什么?请记住,我不想像http://blogs.iona.com/sos/20070410-WSDL-Versioning-Best-Practise.pdf中描述的那样实现向后兼容性。.我只想在wsdl中记录版本。 最佳答案 我不知道用于指定版本的专用WSDL
我想记录我的源代码(C#源代码),实际上我使用XML文档标记定义。如何通过特定标签定义?例如,我经常使用按契约(Contract)设计的断言。我想要文档部分对于前提条件,后置条件,不变量......编写如下文档应该是可取的:///arg!=null///return>0由于我不是XML大师,你们中的某个人(大师)可以给我建议吗?我尝试使用,但(对我而言)不可能正确构建文档。非常感谢 最佳答案 首先是一个veryusefulldescriptionxml注释的可能性。接下来,生成文档的应用程序必须知道您自制的标签。我目前不知道可以使用
通过使用include标签,我试图将我的代码的注释放在单独的文件“docs.xml”中。但它不起作用。我一直在尝试C#和VB.NET项目。这是我的评论文件:Demosummary我有一个ABC类,只有一个属性演示。在我写的这个属性之前:///或在VB.NET中:'''但是ABC.Demo的摘要从未出现在InteliSense/对象浏览器/另一个项目中(如果我引用我的项目)。我有一种强烈的感觉,我在这里遗漏了一些东西。附言我试过遵循XML文件的“路径[@name=]”模式,但它没有帮助。 最佳答案 也许您当时已经在文档中看到了这一点,
quartzxml文件(特别是jobs.xml)的文档在哪里?我找到了javadoc在线,但我似乎找不到有关如何编写xml文件的文档,只是一些简短的示例,例如thisonefromO'Reilly.编辑:显然读取jobs.xml的java类是JobInitializationPlugin,但我也没有在其中看到xml格式的文档。 最佳答案 这真的很少记录。超越briefmentionattheOpenSymphonysite,唯一的文档以DocumentTypeDefinition(DTD)的形式出现和一个XMLSchema.如果您熟
关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭5年前。Improvethisquestion我现在使用SandcaSTLe有一段时间了,我也习惯于在.Net源引用中查找xml内联注释。它们通常与msdn上的描述完全匹配。自从.Net4.6和.NetCore以来,Microsoft似乎以不同的方式创建了他们的评论。(再也无法在.Net源代码引用中找到它们)一个例子:https://msdn.microsoft.com/de-de/library/system.
我们向外部客户提供了许多程序集,但并非所有公共(public)API都得到官方支持。例如,由于并非最佳设计选择,有时必须从程序集中公开公开一个类型,我们的其余代码才能正常工作,但我们不希望客户使用该类型。传达缺乏支持的一部分是不以XML注释的形式提供任何智能感知。有没有办法选择性地抑制XML注释?我正在寻找除了忽略警告1591之外的其他东西,因为这是一个长期维护问题。示例:我有一个包含公共(public)类A和B的程序集。A是官方支持的,应该有XML文档。B不适合外部使用,不应记录在案。我可以打开XML文档然后取消警告1591。但是当我稍后添加官方支持的C类时,我希望编译器告诉我我搞砸