方法参数委托的参数如何优雅的文档注释
这个问题我很早就想处理,但是一直忘了,今天写代码时写了下Action参数有2个(bool,string),但是注释时没有什么好的方式注释,于是查了下MSDN,发现一个list标签,试了下,效果很好~
使用方式:
/// <summary>
/// 绘制所有的T类型模块数据
/// </summary>
/// <param name="title"></param>
/// <param name="setBackColor">是否设置背景颜色,如果是,那么没有选择运行时模块将会设置对应颜色</param>
/// <param name="drawModuleDataAction">绘制模块数据</param>
/// <list type="drawModuleDataAction">
/// <listheader>
/// <term>drawModuleDataAction</term>
/// <description>参数说明↓</description>
/// </listheader>
///
/// <item>
/// <term>T:</term>
/// <description>T类型模块数据</description>
/// </item>
/// <item>
/// <term>string:</term>
/// <description><paramref name="setBackColor"/>为true并且没有选择运行时模块将会返回对应的tooltip,选择了运行时模块或者<paramref name="setBackColor"/>为false返回string.Empty</description>
/// </item>
/// </list>
protected void DrawShowCurrentAllModuleData<T>(string title,bool setBackColor,Action<T,string> drawModuleDataAction) where T:ModuleData
{}
效果如下: