关于winform 程序注释问题.

[LanPst]

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

[w5588660]

个人有个人的方法，你找你们公司的或者上网找些看看，看看别人的思路，在结合自己的想法来注释

[hztltgg]

写注释还不如把代码重构的漂亮点

[浪子-无悔]

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

[兔子-顾问]

几年前考虑过。基本是遵循c#命名规范和c++的注解方法。

[yanele]

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

是个不错的主意！

[机器人]

[Quote=引用 2 楼 hztltgg 的回复:]
写注释还不如把代码重构的漂亮点
[/Quote]

这个是前提啊。如果是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>

[Dobzhansky]

对于大的类型, 用partial class 分割文件后

region 分块, 分块依据自己掌握

外部可见元素必须用 doc comment.

[foxd]

#region Private Method
...
#endregion

顶

[deyygywxf]

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

[LanPst]

这个好这个好..
谢谢哈...
看来还要多看看别人的代码布局.

[Quote=引用 6 楼 fangxinggood 的回复:]
引用 2 楼 hztltgg 的回复:
写注释还不如把代码重构的漂亮点



C# code

这个是前提啊。如果是UI层的代码，比如：
#region UI Event Handler
...
#endregion

#region UI Input Check Method
...
#endregion

#region Logic Method……
[/Quote]

[萤火架构]

注释先多写，写的多了，就知道怎么写才更好了