让C#智能注释时显示更加明晰
当我们自定义一些方法时,总想给自己定义的方法添加一些注释,但是当注释过于长时,会出现多种情况给阅读造成相当麻烦,如下列出二种
第一种:长长的一段如下图所示

第二种:如上图对方法进行解释时,如带有一、二、三条时,会给自己造成阅读混乱
解决之道:使用<para>*****</para>标签对进行注释如下代码
/// <summary>
/// 用户登陆服务端动作:
/// <para>动作原理:方法接收远程二进制数据,并记录下接收远程数据的IP地址,端口号,及状态</para>
/// <para>1、对接收二进制数据进行反序列化,成为带有用户名及密码的的数据集合体/para>
///<para> 2、打开数据链接</para>
///<para> 3、</para>
/// <para>4、给用户名赋值</para>
/// <para>5、给密码字串赋值</para>
/// <para>6、给远程IP赋值</para>
/// <para>7、执行查询返回,datareader</para>
/// <para>8、对DataReader进行读取</para>
/// <para>9、读取第0段</para>
/// </summary>
/// <param name="msg"></param>
/// <param name="Ip"></param>
/// <param name="Port"></param>
/// <param name="State"></param>
private void UserLogin(ClassMsg msg, System.Net.IPAddress Ip, int Port, int State)
{
得到效果如图:

自定义方法无论阅读还是使用会方便很多。

浙公网安备 33010602011771号