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

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

在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注释

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

你可能感兴趣的:(xml,C#)