`

Visual C# 中XML注释的使用(含注释在开发时显示换行)

c# 
阅读更多

在C#智能注释时,常常希望它能在开发时显示为换行,使得提示更加友好!原来一直想怎么实现,今天偶然发现原来如此简单,只需将<para> 标记用于诸如 <summary>、<remarks> 或 <returns> 等标记内即可。环境:VS.NET2008

一、注释在开发时换行显示的办法

<para> 标记用于诸如 <summary>、<remarks> 或 <returns> 等标记内,使您得以将结构添加到文本中。

/// <summary>
/// 基类(第1行)
///<para>说明:(第2行)</para>
///<para>  封装一些常用的成员(第3行)</para>
///<para>  前面要用全角空格才能显示出空格来(第4行)</para>
/// </summary>
public class MyBase
{
    /// <summary>
    /// 构造函数(第1行)
    ///<para>说明:(第2行)</para>
    ///<para>  初始化一些数据(第3行)</para>
    /// </summary>
    public MyBase()
    {
         //
    //TODO: 在此处添加构造函数逻辑
    //
    }
}
抄自:http://blog.csdn.net/wonsoft/archive/2009/01/02/3685268.aspx
分享到:
评论

相关推荐

    Visual C# 2008从入门到精通.pdf

     本书同时还介绍了大量Visual C# 2008的开发经验,对使用中的重点、难点进行了专门的讲解,是一本有效、实用的从入门到精通级的学习指南。  本书适合于学习Visual C# 2008技术的初、中级读者使用,如果是初学者,...

    C#.NET必备工具GhostDoc为代码生成注释文档GhostDocPro_v4.5_Cracked

    C#中XML格式的文档注释好处多多:Visual Studio会在很多地方显示这些注释内容(例如,编辑器的工具提示或对象浏览器),还有一些工具(比如NDoc或微软的文档工具Sandcastle) 也可以利用这些注释生成具有良好外观的...

    C#XML入门经典 C#编程人员必备的XML技能.part2

    C# XML入门经典——C#编程人员必备的XML技能 作者:[美]Stewart Fraser, Steven 著,毛尧飞,崔伟 译 出版社:清华大学出版社 出版时间:2003年11月 第1章 在C#中使用XML的原因 &lt;br&gt;1.1 使用XML的原因...

    C# 编程指南 C# 随身参考 Wego开发组专用

    XML 文档注释(C# 编程指南) 平台部分 应用程序域(C# 编程指南) 程序集和全局程序集缓存(C# 编程指南) 属性(C# 编程指南) 集合类(C# 编程指南) 异常和异常处理(C# 编程指南) 互操作性(C# ...

    C#开发实例大全(基础卷).软件开发技术联盟(带详细书签) PDF 下载

    《C#开发实例大全(基础卷)》筛选、汇集了C#开发从基础知识到高级应用各个层面约600个实例及源代码,每个实例都按实例说明、关键技术、设计过程、详尽注释、秘笈心法的顺序进行了分析解读。全书分6篇共25章,主要...

    使用GhostDoc为代码生成注释文档

    C#中XML格式的文档注释好处多多:Visual Studio会在很多地方显示这些注释内容(例如,编辑器的工具提示或对象浏览器),还有一些工具(比如NDoc或微软的文档工具Sandcastle)也可以利用这些注释生成具有良好外观的...

    vscode-docomment:生成Visual Studio Code的XML文档注释

    C# for Visual Studio Code (powered by OmniSharp)支持C# for Visual Studio Code (powered by OmniSharp)现在正式支持 (2020年12月18日)中的文档注释。 您可以通过打开Editor: Format On Type来使用正式版本。 ...

    编写代码文档资料ndoc1.3

    使用 NDoc 时,您仍然在编写代码的技术文档,但您是在编写代码的过程中完成了文档编写工作(在 XML 注释中),而这更容易忍受。使用 NDoc 时,第一步是为您的程序集打开 XML 注释生成功能。右键单击该项目并选择 ...

    创建代码文档的工具(NDoc)

    NDoc 工具能够使用反射来分析程序集,并使用从 C# XML 注释生成的 XML 自动为代码生成文档资料。XML 注释仅适用于 C#,但有一个名为 VBCommenter 的 Visual Studio .NET Power Toy,它能够为 Visual Basic .NET 完成...

    AS Eclipse VisualStudio快捷生成属性

    6 代码段注释/取消注释功能:ctrl+/ (选中的代码如果被注释掉,则执行取消注释,否则执行注释,支持c#、c++、vb、xml) 7 在文档编辑的tab页,增加关闭所有文档菜单: ctrl+shift+f4 8 统计代码行数,在点击主菜单: ...

    C#微软培训资料

    C#语言在.NET 框架中的作用及其特性 1.1 Microsoft.NET 一场新的革命 1.1.1 什么是.NET 2000 年 6 月 22 日 不论对 Microsoft 还是对整个 IT 业界都将成为值得纪念的一天 这一天 微软公司正式推出...

    C# 编程指南 [微软官方 MSDN 节选]

    XML 文档注释(C# 编程指南) 平台部分 应用程序域(C# 编程指南) 程序集和全局程序集缓存(C# 编程指南) 属性(C# 编程指南) 集合类(C# 编程指南) 异常和异常处理(C# 编程指南) 互操作性(C# 编程指南) ...

    【VS2019插件】CodeMaid

    一个开源的Visual Studio扩展,用于清理和简化C#,C++,F#,VB,PHP,PowerShell,R,JSON,XAML,XML,ASP,HTML,CSS,...设置注释格式以在指定列处换行,并将标签排列在单独的行上。按需运行或在清理期间自动运行。

    C#编程经验技巧宝典

    C#编程经验技巧宝典源代码,目录如下: 第1章 开发环境 1 &lt;br&gt;1.1 Visual Studio开发环境安装与配置 2 &lt;br&gt;0001 安装Visual Studio 2005开发环境须知 2 &lt;br&gt;0002 配置合适的Visual Studio 2005...

    ASP.NET Web API如何将注释自动生成帮助文档

    如果要将注释作为Web API帮助文档的一部分,比如在帮助文档的Description栏目中显示方法注释中的summary,需要进行一些配置操作。 首先在Visual Studio中打开Web API项目的属性页,在Build设置页,选中XML document ...

Global site tag (gtag.js) - Google Analytics