java - 这是正确的命名约定吗？

Question

假设我们有一个方法调用另一个方法。

public readXMLFile()  {
    // reading each line and parsing each line to return node.
   Node = parse(line);
}

private parse() {

}

现在使用更全面的函数名称(例如“readXMLFileAndParse”)是一个好习惯吗？专业人士:它为调用者提供了有关该函数应该执行的操作的更全面的信息。否则客户端可能想知道它是否只读取“解析”实用程序在哪里。

换句话说，我认为函数名称的一个明显优势是可以全面涵盖嵌套在其中的所有 Activity 。这是正确的做法吗？又或者这被认为是一个好的做法吗？

Answer 1

这是一个准则，每个方法只能有一个工作(单一职责)。然而，这会导致命名问题，其中方法将返回子方法组合的结果。

因此，您应该为其命名来描述其主要功能:解析文件。读取文件是其中的一部分，但对于最终用户来说并不重要，因为它涉及到。

话又说回来，您必须考虑这到底意味着什么:没有人只是为了解析文件而解析它。您检索数据吗？你写数据吗？

您应该描述对该文件的操作，但不要像“readfile”或“parsefile”那样字面意思。RetrieveCustomers 如果您正在读取客户，则会更具描述性。

public List<Customer> RetrieveCustomers() {
 // loop over lines
 // call parser
}

private Customer ParseCustomer() { }

如果您愿意分享您正在尝试解析的确切内容，那将会有很大帮助。