转移所有权的方法的命名约定

Question

考虑以下示例：

class Foo
{
    private Bar x;

    // ...

    public Bar getAndResetX()
    {
        Bar result = x;
        x = new Bar();
        return result;
    }
}

此类方法是否有既定的命名约定？比如yieldX、transferX之类的？

Answer 1

我们过去使用约定 Adopt 和 Orphan 作为前缀，以在方法名称中提供意图（摘自 Taligent 关于 C++ 的书籍）。

Bar b = foo.orphanBar(); // take Bar out of Foo
foo.adoptBar(b); // put it right back in

您可以使用类似的方法来提供对象的所有权线索。坦率地说，尽管我会坚持使用添加和删除的Java约定。它们提供了足够的意图，其他程序员将不需要阅读解释新约定的注释。

Bar b = foo.removeBar(); // take Bar out of Foo
foo.addBar(b); // put it right back in

Answer 2

我不确定此类方法是否有命名约定。恕我直言，我会使用动词take（例如takeX()）。有关方法命名约定的详细信息，请参阅 JLS § 6.8.3 方法名称。

但老实说，这实际上只是一个意见问题。如果您真的很担心，我建议您浏览 Java API 用于功能等效的方法，然后根据这些方法命名您的方法。

Answer 3

Mozilla 的本机智能指针类使用 forget() 方法来指示所有权转移：

already_AddRefed<nsIFoo> GetFoo() {
    nsCOMPtr<nsIFoo> foo = ...
    ...
    return foo.forget();
}