关于winform 程序注释问题.

Question

特别是界面部分..
想问下.如何规范注释..
 因为包含一些逻辑方法 和 界面控件事件方法.
很多很乱..
所以想问下 如何对代码排版 及 注释..
 不知大家有没有好的建议 ?

Answer 1

注释问题，
可以给你推荐个简单的。
方法前先加 /// 自动生成注释信息。然后将方法名称和参数等等写进去。
写好后，将每个方法 增加 #regedion #endregon 框起来。这样看着就简洁很多。其实注释完全根据个人喜好。可以找一些别人优秀的代码风格参考。

Answer 2

这个是前提啊。如果是UI层的代码，比如：
#region UI Event Handler
    ...
#endregion#region UI Input Check Method
    ...
#endregion#region Logic Method
    ...
#endregion#region Private Method
    ...
#endregion
各个处理的方法分开。再加上完整的注释：
/// <summary>
/// Determimes if a metadata exists in the database.
/// </summary>
/// <param name="resList"> the id of the resource to get metadata</param>
/// <param name="properties">The list of the desired properties.</param>
/// <returns>request with a list of Triples</returns>

Answer 3

对于大的类型, 用partial class 分割文件后region 分块, 分块依据自己掌握外部可见元素必须用 doc comment.

Answer 4

#region Private Method
    ...
#endregion顶

Answer 5

注释问题，
可以给你推荐个简单的。
方法前先加 /// 自动生成注释信息。然后将方法名称和参数等等写进去。
写好后，将每个方法 增加 #regedion #endregon 框起来。这样看着就简洁很多。其实注释完全根据个人喜好。可以找一些别人优秀的代码风格参考