如下简单的demo代码,环境可以随意想象,三撇注释该如何写比较得当?谢谢各位大虾了。每个方法,都是返回一个具有一个 int 参数类型,并返回 Result<T> 对象的方法,每个方法中又有自己的逻辑,那么这每个方法的三撇注释如何描述能够显得完整和恰当呢?(最好能够有 MSDN 那样简单明了的注释)。
using System;namespace ClassLibrary1
{
public delegate Result<T> Action<T>(int num); public class Class1
{
/// <summary>
/// </summary>
/// <param name = "num"></param>
/// <returns></returns>
public Action<string> FunctionA(Func<int, bool> num)
{
return i => num(i) ? new Result<string>(i.ToString()) : null;
} /// <summary>
/// </summary>
/// <param name = "action"></param>
/// <returns></returns>
public Action<bool> FunctionB(Action<int> action)
{
return i => action(i).Vlaue == 0 ? null : new Result<bool>(true);
} /// <summary>
/// </summary>
/// <typeparam name = "T"></typeparam>
/// <param name = "a1"></param>
/// <param name = "a2"></param>
/// <returns></returns>
public Action<T> FunctionC<T>(Action<T> a1, Action<T> a2)
{
return i => a1(i) ?? a2(i);
}
} public class Result<T>
{
public Result(T value)
{
Vlaue = value;
} public T Vlaue { get; private set; }
}
}
using System;namespace ClassLibrary1
{
public delegate Result<T> Action<T>(int num); public class Class1
{
/// <summary>
/// </summary>
/// <param name = "num"></param>
/// <returns></returns>
public Action<string> FunctionA(Func<int, bool> num)
{
return i => num(i) ? new Result<string>(i.ToString()) : null;
} /// <summary>
/// </summary>
/// <param name = "action"></param>
/// <returns></returns>
public Action<bool> FunctionB(Action<int> action)
{
return i => action(i).Vlaue == 0 ? null : new Result<bool>(true);
} /// <summary>
/// </summary>
/// <typeparam name = "T"></typeparam>
/// <param name = "a1"></param>
/// <param name = "a2"></param>
/// <returns></returns>
public Action<T> FunctionC<T>(Action<T> a1, Action<T> a2)
{
return i => a1(i) ?? a2(i);
}
} public class Result<T>
{
public Result(T value)
{
Vlaue = value;
} public T Vlaue { get; private set; }
}
}
欢迎使用CSDN 小秘书
***********************************************************[/align]
/// <summary>
/// 根据num(i)的布尔类型返回值
/// </summary>
/// <param name="num">函数数量</param>
/// <returns>返回结果</returns>
public Action<string> FunctionA(Func<int, bool> num)
{
return i => num(i) ? new Result<string>(i.ToString()) : null;
}
/// <summary>
/// 根据action(i)的值判断返回值
/// </summary>
/// <param name = "action">方法参数</param>
/// <returns>返回结果</returns>
public Action<bool> FunctionB(Action<int> action)
{
return i => action(i).Vlaue == 0 ? null : new Result<bool>(true);
}
/// </summary>
/// <param name="filename"></param>
/// <returns></returns>