标签: xml-comments

在整个或C#源代码中,我们有很多评论错过了实际内容,如下所示:

/// <summary>
/// </summary>

或这个:

/// <summary>
///
/// </summary>

或这个:

/// <param Name="flag"></param>

不幸的是,Visual Studio不会为此类缺失注释生成警告.但是对于我们来说,如果我们可以在视觉工作室内点击列表中的项目(例如,警告列表)然后被带到源代码中的错误位置来纠正它将会很好.此外,在每次构建xml文件时都会看到缺少xml注释内容的列表.你对如何实现这个有任何想法吗？

我无法找到如何执行此操作,Visual Studio SDK参考也不是很有帮助.

我正在试图弄清楚如何获得NormalizedSnapshotSpanCollectionXML评论.我想在它们旁边放一个图标...我不希望每行旁边有一个图标,但只是在每个组的第一行旁边...

///<summary>SomeXML Comment</summary>   [ICON]
///<remarks>some remarks</remarks>
public void Foo()
{
    ///Some false XML comment line that does not get an icon.
}

我最近转到了vb.net中c#.net的编码

在c#中我可以击中///任何类/方法,Visual Studio会自动为我生成xml注释主体.

例

        /// <summary>
        /// 
        /// </summary>
        /// <param name="bar"></param>
        void foo(string bar)
        {

        }

如何在我的vb.net项目中获得相同的行为

我已经尝试'''进入或空间但它什么也没做.我在两个项目中都使用相同的IDE

是否可以从Visual Studio生成的XML注释文件生成一组Wiki页面？

我说的是像Sandcastle这样的东西,但是对于wiki格式而不是编译的CHM.

编辑:我正在使用MediaWiki,可以导入/导出XML文章.所以我希望能够编写一个将XML注释转换为MediaWiki XML的转换.

我有一个WCF服务并评论我的运营合同如下:

    /// <summary>
    /// Call to topup a card.
    /// </summary>
    /// <param name="topUp">The TopUp object which specifies the card to topup.</param>
    /// <returns>Returns a boolean indicating whether call has finished successfully.          </returns>
    [OperationContract]
    bool UploadTopUp(TopUp topUp);

但是,我在上面的3个正斜杠中添加的XML注释///不出现在我的客户端应用程序中的工具提示中,这是标准的WCF/Web服务功能吗？他们会不会出现？或者有没有办法让它们出现？

我正在使用Sandcastle帮助文件生成器为我的库构建帮助文件.该库有三个版本(.NET,Silverlight和Windows Phone 7),它们是基于相同的代码库构建的.

我想在帮助文件页面底部的方法名称和版本信息旁边添加平台图标.类似于下面的截图.如何将此类信息添加到我的帮助文件中？

我们是一家微软商店,专注于使用C#.我们有几个项目,包括网站,Windows服务和类库,它们包含XML注释.

我希望为每个项目生成MSDN样式的HTML文档,并将其部署到一个所有开发人员都可以轻松访问的集中位置.我还希望自动化这些步骤,以便它们可以定期运行,因此我和其他开发人员无需担心在进行更改时记住生成和部署新文档.我看过Sandcastle和Doxygen,它们看起来都是生成我想要的文档的好选择,但是我需要一个很好的方法来自动生成它,比如夜间工作或其他什么.

有人这样做吗？我不是最终结果是HTML出售; 特别是如果有更好的主意.

编辑:

我很欣赏所有好主意.现在我可以调查一些路线了,但是直到弄脏我才知道哪条路线效果最好.Sandcastle帮助文件生成器似乎为我提供了我想要做的最佳选择,所以我会对这个建议表示赞同.但是,如果我有更多时间研究XSLT和CSS解决方案以使XML数据看起来恰到好处,那么我首先会追求这个建议.

再次感谢大家!

我正在学习如何在visual studio和C#中使用XML文档功能.

文档中使用的默认XML标记是"summary","param name"和"returns".

我想在默认标签上添加"备注".我还想添加自定义标签.

我查看了MSDN,XML文档教程和stackoverflow,但没有找到实现此目的的方法.任何建议都非常感谢,谢谢!

标记

我已将信息添加到图形编辑器中的Documentation.Summary属性中,但未将其添加到生成的类中.有没有办法做到这一点？

<!-- Comment -->是在XML文件中添加注释的方法.这实际上是不是意味着这部分不是"编译"的？

但是,当我做这样的事情时:

<item android:id="@+id/ss3"
    android:icon="@drawable/some_icon"
    android:title="Blabla Title"
    tools:ignore="AppCompatResource"
    <!-- -->
/>

我收到错误"标签启动未关闭".为什么？