函数应该以“Get”开头吗？

Question

我正在尝试查看 C# 编码标准，以使我的代码更加美观和标准，我有一个问题：根据 C# 编码标准，函数（不是 void 的方法）是否应该以“Get”开头？例如：“GetSongOrder()”、“GetNextLine()”等？

谢谢。

Answer 1

有两种情况：

如果例程可以非常快速地“获取”值，而不会在代码中造成副作用，我建议使用属性 getter，并省略“获取”名称：

public SongOrder SongOrder
{
   get { return this.songOrder; } // ie: an enum
}

但是，如果需要处理，则名称为“Get...”的方法是合适的。这表明调用此方法可能会产生副作用，例如额外的处理或某些状态的更改：

public string GetNextLine()
{
    string line = this.stream.ReadLine(); // This may cause a longer running operation, especially if it's using Disk IO/etc
    // do other work?
    return line;
}

Answer 2

您的函数名称应该简洁且有意义。不多不少。

如果 get 适合您，则使用 Get。如果检索有效，请使用它。

命名约定没有真正的“标准”。

Answer 3

一般来说，函数的动词-名词命名约定很常见。 “获取”只是您可能看到的动词之一。它也可以是“激活”、“关闭”、“转储”或任何东西......这只是英语和一般编码的结果，方法或函数通常会对“某种类型的对象”进行“做某事” '。

Answer 4

我还没有看到这方面的 C# 标准，但我见过的大多数实际代码都使用“getter”属性，并且它们在函数名称中省略了“Get”一词。
示例：

Public SongOrderList SongOrder
{
    get
    {
      return mySongOrderList;
    }
}

使用“Get”（和“Set”）作为函数名称前缀是我在不具有 .NET 属性的语言（例如 C、Java 等语言）中经常看到的情况。

编辑：

...当然你也可以有setter

Public SongOrderList SongOrder
{
    get
    {
      //do some processing code here
      return mySongOrderList;
    }
    set
    {
      //do some processing code here
      mySongOrderList = value; //value is a C# keyword, in case you didn't know. it is the parameter to the setter
    }
}

当然，如果你想要一个getter和一个setter并且你不需要任何额外的处理，只需要纯Java-bean-like get/设置 youc 并执行此操作：

Public SongOrderList SongOrder
    {
        get; set;
    }

如果您只想要一个 PUBLIC getter，则可以执行此操作（我认为 - 已经有一段时间了）：

Public SongOrderList SongOrder
    {
        public get; private set;
    }

Answer 5

不，没有标准规定函数应该以“Get”开头。

当创建有意义的函数名称时，它们通常采用这种形式，例如 GetHashCode 函数。开头的其他动词很常见，例如在 ToString 函数中，并且只有像在 Encode 函数中的动词。

还有其他形式，您可以在其中描述函数的结果，例如 Substring 函数。

Answer 6

除了其他答案 - 如果您有像 GetNextLine() 这样的方法，您可能需要考虑返回枚举，例如

IEnumerable; GetLines();