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

转载 2013年12月03日 11:55:47

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

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

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

  1. /// <summary>
  2. /// 基类(第1行)
  3. ///<para>说明:(第2行)</para>
  4. ///<para>  封装一些常用的成员(第3行)</para>
  5. ///<para>  前面要用全角空格才能显示出空格来(第4行)</para>
  6. /// </summary>
  7. public class MyBase 
  8. {
  9.     /// <summary>
  10.     /// 构造函数(第1行)
  11.     ///<para>说明:(第2行)</para>
  12.     ///<para>  初始化一些数据(第3行)</para>
  13.     /// </summary>
  14.     public MyBase()
  15.     {
  16.          //
  17.     //TODO: 在此处添加构造函数逻辑
  18.     //
  19.     }
  20. }

二、XML注释

C#xml<summary>注释 换行、空行

为函数方法注释说明要用到 xml 语句  段落说明  、 新段示例说明 、   空行要加入全角空格 下面的注释会破坏原有标注结构: /// 第一行 说明 /// ...
  • ou832339
  • ou832339
  • 2014年03月29日 22:57
  • 3622

让C#智能注释时显示为换行

让C#智能注释时显示为换行
  • anyqu
  • anyqu
  • 2010年10月21日 10:07
  • 1613

C# 注释换行

在写程序的时候,有时需要对注释进行换行.如下: class Program  {      static void Main(string[] args)      {     ...
  • yangbindxj
  • yangbindxj
  • 2013年11月19日 14:30
  • 2424

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

在C#智能注释时,常常希望它能在开发时显示为换行,使得提示更加友好!原来一直想怎么实现,今天偶然发现原来如此简单,只需将 标记用于诸如 、 或 等标记内即可。环境:VS.NET2008 一、注释在...
  • cqkxzyi
  • cqkxzyi
  • 2012年03月31日 13:38
  • 997

关于C#引用dll动态链接库文件的注释问题

1、dll动态库文件项目生成属性中要勾选“XML文档文件”注意:1)、要选中项目,查看项目属性,选中解决方案是找不到的。2)、XML文件的名字不要修改。2、添加引用时XML文件要与DLL文件在同一个目...
  • testcs_dn
  • testcs_dn
  • 2017年08月06日 16:27
  • 621

C#的XML代码注释

在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾。 在Java中,多行注释(Multiline Comment)分为两种形式: ...
  • czjuttsw
  • czjuttsw
  • 2012年12月18日 19:38
  • 3626

VS2013等版本中怎么写函数注释可以鼠标悬停自动显示

项目里代码多了,鼠标一指哪个函数就能有注释是比较方便的,但是我写了半天注释,鼠标怎么点也不自动显示,就查了下写在这里给需要的人参考下。 方法如下: 注释要写在函数实现的地方,才可以自动显示(我都是写...
  • hyqsong
  • hyqsong
  • 2015年11月15日 10:26
  • 2248

C# 读取xml文件忽略xml文件的注释

默认情况下,读取xml文件是不忽略注释的,这样读取带注释的节点会造成异常,那么怎么屏蔽掉这些注释呢? 方案如下: XmlDocument doc = new XmlDocument(); XmlRea...
  • xunzaosiyecao
  • xunzaosiyecao
  • 2014年12月31日 20:59
  • 3188

在Visual studi C#的“///”注释内容生成XML文档

实际上该方法适合于所有版本的Visual studio,方法很简单,设置一下Visual studio的项目属性和工具选项即可。 1.在菜单栏的“Project”中选择当前项目的“*** Pro...
  • gtosky4u
  • gtosky4u
  • 2015年07月23日 09:30
  • 934

Visual Studio安装Visual Assist后中文注释提示错误问题

我使用的是VS2010,最近安装了一个小插件Visual Assist,安上之后所有的注释只要出现中文的地方下方都会有错误提示的红线,看着很别扭,下面提供解决方法。 点击小番茄的按钮,如下图...
  • oktears
  • oktears
  • 2013年09月29日 20:35
  • 2849
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Visual C# 中智能提示(XML注释)的使用(含注释在开发时显示换行)
举报原因:
原因补充:

(最多只允许输入30个字)