Visual C# 中XML注释的使用(含注释在开发时显示换行)
程序员文章站
2022-06-07 09:07:49
...
在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