c# – 如何命名方法

发布时间：2020-12-15 19:35:24 所属栏目：百科来源：网络整理

导读：我在争论这个方法的名称. CloseCashTransaction(Cash.Id,-1,true); 要么 CompleteCashTransaction(Cash.Id,true); 或者两者都不好？在业务术语/流程中,通过发送这三个值,我实际上是在工作流程中“关闭交易”或“完成交易”. 但是在开发者方面,我无法推断wtf

我在争论这个方法的名称.

CloseCashTransaction(Cash.Id,-1,true);

要么

CompleteCashTransaction(Cash.Id,true);

或者两者都不好？

在业务术语/流程中,通过发送这三个值,我实际上是在工作流程中“关闭交易”或“完成交易”.

但是在开发者方面,我无法推断wtf“完全”或“关闭”的意思.它迫使我调查方法的内部.我的斗争是,我试图命名方法来推断他们在做什么.完全是一般的过于通用,并强迫方法的消费者每次我使用这样的单词时潜入代码.

当我在整个代码中看到这样的东西时,我必须花很多时间来弄清楚它们实际上在做什么.如果评论很糟糕,我最终不得不查看该方法中的所有逻辑,因为注释和方法名称确实可以推断出正在发生的事情.

解决方法

从C#编码标准….

6.8方法
方法应使用以下格式命名：

动词形容词Noun Qualifier(s)

例：

private Ball FindRedCansByPrice( 
     float price,ref int canListToPopulate,out int numberOfCansFound )

指南：

>参数应按其分组
可变性(从最少到最多
可变的)如示例中所示
以上.
>如果可能的话,避免从他们的中间退出方法.一口井
书面方法应该只退出
一点：最后.
>避免使用大型方法.方法的身体接近20到30
代码行,寻找那些块
可以分成他们自己的方法
并且可能由其他方法共享.
>如果您发现自己多次使用相同的代码块,
这是一个单独的好人选
方法.
>将类中的方法组合成一个区域并按使用频率对它们进行排序(即,更常用的方法应该在其区域的顶部附近.

希望能帮助到你

奖金

命名零件和对

>普通形容词对

>老…… /新……
>来源…… /目的地……
>来源…… /目标……
>首先…… /下一个…… /当前…… /上一个…… /最后……
> Min … / Max …

>公共属性前缀

>允许……(允许……)
>可以……
>包含……
>有……
>是……
>使用……(使用……)

>普通动词对

>添加… /删除…
>插入… /删除…
>增量/ ……减少……
>锁定…… /解锁……
>开始…… /结束……
>获取… /存储…
> To … / From …(隐含转换)
>打开…… /关闭……
>创建…… /摧毁……
>获取… /发布……
> Up … / Down …
>显示…… /隐藏……
>开始…… /停止……

>普通限定符后缀

> …平均
> …限制
> ……伯爵
> …参考
> …进入
> …总和
> …索引
> …总计

注意：由于语义原因,避免使用Num;请改用Index和Count.另外,避免使用Temp;花时间描述对象的真实含义(例如使用SwapValue而不是TempValue).

（编辑：李大同）

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