c# - 将派生值作为属性公开是一种好的形式吗？

Question

我需要在给定 7 个潜在输入的情况下得出一个重要的值。 Uncle Bob敦促我避免使用那么多参数的函数，所以我已经 extracted the class .所有参数现在都是属性，我只剩下一个没有参数的计算方法。

“那个”，我认为，“可能是一个属性，但我不确定这是否是 C# 的惯用语。”

我应该将最终结果公开为属性，还是不带参数的方法？一般的 C# 程序员会觉得属性令人困惑或令人反感吗？ Alt.Net 人群呢？

decimal consumption = calculator.GetConsumption(); // obviously derived
decimal consumption = calculator.Consumption; // not so obvious

如果是后者:我是否也应该将中期结果声明为[私有(private)]属性？感谢重磅method extraction ，我有几个中期结果。其中许多不应成为公共(public) API 的一部分。不过，其中一些可能很有趣，如果我可以将它们作为属性访问，我的表达式看起来会更清晰:

decimal interim2 = this.ImportantInterimValue * otherval;

快乐实验部:

在 VS2008 中调试我的代码时，我注意到我一直将鼠标悬停在计算中间结果的方法调用上，期望鼠标悬停在它们的返回值上。将所有方法转换为属性后，我发现将中间结果公开为属性极大地有助于调试。我对此很满意，但对可读性仍有挥之不去的担忧。

临时值声明看起来更困惑。然而，表达式没有括号更容易阅读。我不再觉得必须以动词开头方法名称。对比:

// Clean method declaration; compulsive verby name; callers need
// parenthesis despite lack of any arguments.
decimal DetermineImportantInterimValue() {
    return this.DetermineOtherInterimValue() * this.SomeProperty;
}

// Messier property declaration; clean name; clean access syntax
decimal ImportantInterimValue {
    get {
        return this.OtherInterimValue * this.SomeProperty;
    }
}

也许我应该解释一下，我用 Python 编写代码已有十年了。我一直倾向于花费额外的时间使我的代码更容易调用而不是编写。我不确定 Python 社区是否会将这种面向属性的风格视为可以接受的“Pythonic”，但是:

def determineImportantInterimValue(self):
    "The usual way of doing it."
    return self.determineOtherInterimValue() * self.someAttribute

importantInterimValue = property(
    lambda self => self.otherInterimValue * self.someAttribute, 
    doc = "I'm not sure if this is Pythonic...")

Answer 1

这里的重要问题似乎是这样的:

从长远来看，哪个可以为您生成更易读、更可维护的代码？

在我个人看来，与单个单一方法调用相比，将单个计算隔离为属性具有几个明显的优势:

• 无论您使用的是哪种类方法，您都可以看到在调试器中执行的计算。这对调试类时的工作效率大有裨益.

• 如果计算是离散的，属性将执行得非常快，这意味着(在我看来)它们遵守属性设计规则。认为设计指南应该被视为紧身衣的想法是荒谬的。请记住:没有 Elixir 。

• 如果计算被标记为私有(private)或内部，它们不会给类的使用者增加不必要的复杂性。

• 如果所有属性都足够离散，编译器内联可能会为您解决性能问题。

• 最后，如果返回最终计算的 final 方法更易于维护和理解，因为您可以阅读它，这本身就是一个完全令人信服的论点。

您能做的最好的事情之一就是独立思考并敢于挑战我们的同行和前辈先入为主的“一刀切”的观念。每条规则都有异常(exception)。这个案例很可能就是其中之一。

后记:我认为在绝大多数情况下我们不应该放弃标准的属性设计。但有些情况下需要偏离 The Standard(TM)，因为这样做是有意义的。