xml-documentation

    0热度

    1回答

    我正在解析将/doc作为编译器选项传递时生成的XML文件。我们以前一直在使用VSDocman来处理解析和文档网站生成以及自定义主题。我们最终并不喜欢VSDocman生成的网站,但想要用MVC做更强大的功能。 解析XML文件非常简单,但我还想将我可以在VSDocman中定制的主题添加到XML文件中。这在Visual Studio中的内置文档支持中是不可能的吗?我是否必须创建一个自定义XML文件来管理

    2热度

    1回答

    1)是否有人请告诉我XML文档参数名称的值的正确术语?即在我的代码片段的第2和第3行,我叫“iNum1”和“iNum2”是什么? 2)在Visual Studio中,有没有办法让它们停止与我的标识符相同的颜色?我所有的评论都是绿色的,除了那些东西;他们是白色的(像我标识符):-( 谢谢。 PS我使用Visual Studio 2015年

    9热度

    1回答

    假设我有一个方法如下: /// <summary> /// Here I want to reference the parameter <see cref="personId"/>. /// </summary> /// <param name="personId"> /// The person id. /// </param> //

    0热度

    1回答

    每次我使用发布版本发布Web部署包时我调用Web API时会出现此错误; HTTP 500内部服务器错误 找不到文件 'C:\ SolutionDir \ PROJECTDIR \ BIN \ AssemblyName.xml' 这里是我部署到服务器时执行的步骤。 在Visual Studio 2013右键单击项目,然后选择Publish... 检查我很高兴我的发布配置文件,然后单击Publish

    7热度

    2回答

    我想引用<see cref="..." />XML documentation标记中的运算符,但似乎无法找到有关如何执行此操作的提示。该标签上的MSDN article仅显示引用方法的简单示例,但不涉及可引用的不同类型的成员。 特别是,我想引用一个隐式转换运算符,但引用运算符的一般规则也将被赞赏。 例 比方说,我们有一个简单的结构,我们将其定义==,!=和隐式转换操作符: public struc

    0热度

    1回答

    Here我看到了允许用于生成文档的XML标签集(通过SandCastle)。 Wether是否存在用于链接(到网页)的附加XML标签,当用户按下它时,它将通过浏览器打开?如果我使用<a href="...:/>,则CHM文件尝试在其窗口中打开链接,并收到脚本错误消息。

    0热度

    1回答

    在Sandcastle生成的XML注释的基础上生成文档。我想生成英文和俄文版本的文档。 我的XML文件Magic.doc.enu.xml和Magic.doc.rus.xml位于同一个项目(目标dll)。 例如,我可以做到这一点通过这样丑陋的方式: namespace HelloDocs { #if ENU /// <include file='Magic.doc.enu.xml'

    0热度

    1回答

    我按照此tutorial为类库创建API文档。 在我的类库的评论中,我们使用参见标签来引用其他类型。 例如,这是一种含有扩展方法的一类用于System.Action注释: /// <summary> /// Class containing some extension methods for <see cref="Action" />. /// </summary> public sta

    2热度

    1回答

    我正在使用Swashbuckle 5.5.3和使用XMLComments定制的API文档。我已经提供了未在API文档中编辑过的模型属性的描述。 示例代码: /// <summary> /// SomeDetails. /// </summary> /// <param name="Model">SomeDetails.</param> /// <param name="Model.User

    0热度

    1回答

    我正在寻找一种方法来构建包含大型项目的自定义XML元素的帮助文件。我想添加我自己的元素,类似于Summary元素,并让帮助文件包含它。我安装了Sandcastle和Ghost Doc Pro。我一直无法找到一种方法来帮助文件构建者添加我的自定义标签。举个例子: /// <summary> /// the summary /// </summary> /// <cus