c# – 你应该对私有方法评论XML吗？

发布时间：2020-12-15 04:33:38 所属栏目：百科来源：网络整理

导读：所以我在我的代码中使用 XML注释来帮助解释公共方法和公共成员,另一个开发人员提到并不是所有的方法都有XML注释.我使用规则,如果是public或protected,则添加XML注释,如果是private,则不要. 这听起来是合乎逻辑的还是有什么原因为什么你会用XML Comment一个私

所以我在我的代码中使用 XML注释来帮助解释公共方法和公共成员,另一个开发人员提到并不是所有的方法都有XML注释.我使用规则,如果是public或protected,则添加XML注释,如果是private,则不要.

这听起来是合乎逻辑的还是有什么原因为什么你会用XML Comment一个私有的方法？

解决方法

对评论没有强有力的规则,但我认为评论公共/内部/受保护的方法是很好的.

有时我在私人的方式评论时不清楚.理想的代码应该是自述的.例如,如果你有一个方法

Item GetItemByTitle(string title)

那么它不需要写评论,因为它足够清楚.但是,如果一个方法对于其他开发人员可能不清楚,请将其注释或重命名/重构方法事件(如果是私有的).个人而言,我更喜欢阅读代码,而不是评论:)如果你有太多的评论代码变得很难阅读.我的规则是仅在需要时使用注释.

如果在您的项目中,您可以方便地记录所有方法,包括私有方法,然后按照此规则.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!