C# 注释 各个关键字段 使用说明

https://www.cnblogs.com/xdot/p/6632313.html#:~:text=%E5%9C%A8C%23%E6%99%BA%E8%83%BD%E6%B3%A8%E9%87%8A%E6%97%B6%EF%BC%8C%E5%B8%B8%E5%B8%B8%E5%B8%8C%E6%9C%9B%E5%AE%83%E8%83%BD%E5%9C%A8%E5%BC%80%E5%8F%91%E6%97%B6%E6%98%BE%E7%A4%BA%E4%B8%BA%E6%8D%A2%E8%A1%8C%EF%BC%8C%E4%BD%BF%E5%BE%97%E6%8F%90%E7%A4%BA%E6%9B%B4%E5%8A%A0%E5%8F%8B%E5%A5%BD%EF%BC%81%20%E5%8E%9F%E6%9D%A5%E4%B8%80%E7%9B%B4%E6%83%B3%E6%80%8E%E4%B9%88%E5%AE%9E%E7%8E%B0%EF%BC%8C%E4%BB%8A%E5%A4%A9%E5%81%B6%E7%84%B6%E5%8F%91%E7%8E%B0%E5%8E%9F%E6%9D%A5%E5%A6%82%E6%AD%A4%E7%AE%80%E5%8D%95%EF%BC%8C%E5%8F%AA%E9%9C%80%E5%B0%86%3Cpara%3E%20%E6%A0%87%E8%AE%B0%E7%94%A8%E4%BA%8E%E8%AF%B8%E5%A6%82,%3Csummary%3E%E3%80%81%3Cremarks%3E%20%E6%88%96%20%3Creturns%3E%20%E7%AD%89%E6%A0%87%E8%AE%B0%E5%86%85%E5%8D%B3%E5%8F%AF%E3%80%82

I 一级注释
1. <remarks>对类型进行描述,功能类似<summary>,据说建议使用<remarks>;
2. <summary>对共有类型的类、方法、属性或字段进行注释;
3. <value>主要用于属性的注释,表示属性的制的含义,可以配合<summary>使用;
4. <param>用于对方法的参数进行说明,格式:<param name="param_name">value</param>;
5. <returns>用于定义方法的返回值,对于一个方法,输入///后,会自动添加<summary>、<param>列表和<returns>;
6. <exception>定义可能抛出的异常,格式:<exception cref="IDNotFoundException">;
7. <example>用于给出如何使用某个方法、属性或者字段的使用方法;
8. <permission>涉及方法的访问许可;
9. <seealso>用于参考某个其它的东东:),也可以通过cref设置属性;
10. <include>用于指示外部的XML注释;
II 二级注释
1. <c> or <code>主要用于加入代码段;
2. <para>的作用类似HTML中的<p>标记符,就是分段;
3. <pararef>用于引用某个参数;
4. <see>的作用类似<seealso>,可以指示其它的方法;
5. <list>用于生成一个列表;
另外,还可以自定义XML标签

 

 

 

 

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

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

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

/// <summary> 
/// 基类(第1行) 
///<para>说明:(第2行)</para> 
///<para>  封装一些常用的成员(第3行)</para> 
///<para>  前面要用全角空格才能显示出空格来(第4行)</para> 
/// </summary>

posted @ 2023-01-06 09:28  LuoCore  阅读(1213)  评论(0编辑  收藏  举报