[思想火花]:函数命名及参数

我倾向于使用语义非常明确的方式命名一个函数,即使这样写下来函数的名字非常长,例如ClearExpiredFriendLatestNotes之类的.

今天调整一个函数,就是定期清理好友最新日记的一个函数,本质上来说,清理用户好友的最新日记加个过期天数就够了,但是我还要清理影响到的用户的好友最新日记缓存,所以考虑到这点,我需要这个函数返回影响到的好友的用户标识集合,但问题是我今天非常非常有精神头,所以我仔细的犹豫了下,到底是将这个好友用户标识集合做为返回数据还是作为out参数处理.分别如下:

方案1:

public abstract List<long> ClearExpiredFriendLatestNotes(int expireDays);

 

方案2:

public abstract void ClearExpiredFriendLatestNotes(int expireDays,out List<long> effectUsers);

 

相信大部分同学对这2个函数方案都觉得无所谓,但是我今天很特别的仔细想了下,觉得还是使用方案2比较妥当,原因如下:

1 函数的本质意义是清理过期的好友最新日记集合,也就是说,返回值并不具备体现这个函数的作用.

2 调用这个函数的开发人员必须仔细阅读帮助文档,或者感谢那位设置了编译出xml的而且让你拷贝那份xml文档的开发人员,否则他是不会知道这个函数的返回值是干什么的.而使用out参数,而且参数的名称为effectUsers,从语义上起码让调用者明白,这个函数还有一个附属的参数返回.

 

ok

 

不知道大家怎么看?

转载于:https://www.cnblogs.com/csharpsharper/archive/2010/11/19/1881613.html