function - 我应该写更多描述性的函数名称还是添加注释？

Question

这是一个与语言无关的问题，但我正在徘徊人们在可读性和可维护性方面更喜欢什么......我的假设情况是我正在编写一个函数，该函数给定一个序列将返回一个删除所有重复元素的副本，并且顺序颠倒了。

/*
*This is an extremely well written function to return a sequence containing 
*all the unique elements of OriginalSequence with their order reversed
*/    
ReturnSequence SequenceFunction(OriginalSequence)
{...}

或者

UniqueAndReversedSequence MakeSequenceUniqueAndReversed(OriginalSequence)
{....}

以上应该是在第一个实例中使用注释或在第二个实例中使用非常冗长的函数名称来描述函数操作的清晰示例。

干杯，

理查德

Answer 1

我更喜欢冗长的函数名称，因为它使调用站点更具可读性。当然，某些函数名称(如您的示例)可能会变得很长。

也许您的示例函数更好的名称是 ReverseAndDedupe 。哦哦，现在更清楚了我们有一个有两个职责的函数*。也许将其拆分为两个函数会更好: Reverse 和 Dedupe 。

现在调用站点变得更具可读性:

Reverse(Dedupe(someSequence))

* 注意 :我的经验法则是，任何名称中包含“和”的函数都有太多的职责，需要拆分为单独的函数。