CnPack Forum - Powered by Discuz! Board

Subject: 关于过程头注释的建议。 [Print This Page]

Author: 天地弦 Time: 2005-1-31 10:22 Subject: 关于过程头注释的建议。

过程头的注释可不可以定义成像C#的格式
/// <summary>
/// ....
/// </summary>
/// <remarks>
///...
/// </remarks>
/// <param name="conn"></param>
/// <param name="commandType"></param>
/// <param name="commandText"></param>
/// <param name="commandParameters"></param>
/// <returns></returns>
public static int ExecuteNonQuery(SqlConnection conn, CommandType cmdType, string cmdText, params SqlParameter[] cmdParms)
{
SqlCommand cmd = new SqlCommand();
PrepareCommand(cmd, conn, null, cmdType, cmdText, cmdParms);
int val = cmd.ExecuteNonQuery();
cmd.Parameters.Clear();
return val;

}

不知道Delphi可不可以定义成这样的呢

[ Last edited by 天地弦 on 2005-1-31 at 10:23 ]

[ Last edited by 天地弦 on 2005-2-1 at 08:06 ]

Author: 天地弦 Time: 2005-1-31 10:24

我觉得这样的结构注释过程比较明了

Author: Hospitality Time: 2005-2-7 15:08 Subject: 我的看法。

你和我一样,都是C#的爱好者阿。

其实这种设计看起来简单，但是放到代码中用途不大。不像.Net的反射功能，填写这些的用途就是方便调用时给其他调用程序员一些帮助。

For Example:

Form form = new Form();  括号当中提示出构造函数的说明。这就是summary的作用。

再Ex:
namespace HospitalityInCnpack
{
  class Hospitality
  {

string name;
/// <summary>
/// 将内容输出到Private变量name
/// </summary>
/// <param name="name">名称</param>
public Hospitality( string name )
{
      this.name = name;
}

public string Name
{
      get
      {
         return name;
      }
}
  }

  class invoke
  {
public static void Main(string[] args)
{
      Hospitality hos = new Hospitality( args[0] );// 在args[0]里显示出“名字”二字。
      System.Console.WriteLine(Hospitality.Name);
}
  }
}

像这样都是嵌入到IDE开发环境中的，我想实现起来会比较难。那这样的话，就没什么意义可言了。

Author: 天地弦 Time: 2005-2-14 17:09

嘿嘿，我觉得那样比较明了。

Author: zjy Time: 2005-2-14 20:45

目前比较常用的代码文档注释规范有 JavaDoc 和 MS 在 VS.NET 中定义的这种 XML 格式的规范，很多文档生成工具都支持这些规范，CnPack 的代码注释也考虑改成以上两种格式之一。

CnWizards 提供的代码模板不支持参数列表的分隔，以上功能可能需要增加一个单独的代码注释工具来实现。新的工具需要基于语法分析器来做，有一定的工作量，任务单见：
http://www.cnpack.org:8008/cnpack/tktview?tn=168,1

Author: Hospitality Time: 2005-2-15 11:58 Subject: 问题是：这样实现起来，使很难办的。。。XML、反射等功能Delphi原来版本是没有的……

Author: zjy Time: 2005-2-15 12:16

使用自己的语法分析器对源代码进行解析就可以取得必须的信息了，XML 解析也有成熟的第三方代码支持。

Welcome to CnPack Forum (http://bbs.cnpack.org/)