Должен ли метод, возвращающий поток XML, называться
public Stream getXmlStream();
или вместо этого
public Stream getXmlStream();
Как вы относитесь к этому? Что считается лучшей практикой?
Должен ли метод, возвращающий поток XML, называться
public Stream getXmlStream();
или вместо этого
public Stream getXmlStream();
Как вы относитесь к этому? Что считается лучшей практикой?
Нет никакого правильного ответа. Этот wiki экстракт полезен:
Идентификаторы программ часто должны содержать аббревиатуры и инициализации которые уже находятся в верхнем регистре, например "старый HTML файл". По аналогии с правилами титульного дела, естественная обработка верблюжьей кейсы имела бы аббревиатура все в верхнем регистре, а именно "oldHTMLFile". Однако, этот подход проблематичен, когда два акронима встречаются вместе (например, "parse DBM XML" станет "parseDBMXML" ) или когда стандартный мандаты нижнего верблюжьего случая, но название начинается с аббревиатуры (например, "SQL-сервер" станет "sQLServer" ). По этой причине некоторые программисты предпочитают обрабатывать аббревиатуры, как если бы они были в нижнем регистре слова и написать "oldHtmlFile", "parseDbmXml" или "sqlServer".
"Соглашение" - это просто - это не "правило". Тем не менее, я уверен, что getXmlStream()
- лучший вариант. Рассмотрим несколько таких терминов: сравните getSQLDBIOXML()
с getSQLDBIOXML()
Вероятно, вы должны пойти на getXmlStream
. Подумайте о parseDBMXML
или более сложных примерах, которые делают код нечитаемым.
Приходит из википедии CamelCase
Я не говорю, что это так, но для некоторых они могут автоматически корректировать/ожидать, что, когда есть последовательная строка с верхними буквами, за которой следуют буквы с нижним окошком, где-то есть аббревиатура. Мой opinion
должен идти с getXmlStream()
- что-то, что я think
для большинства людей является чем-то более легким, по сравнению с числом тех, кто мгновенно может читать getXmlStream()
с помощью легкость..
с помощью public Stream getXMLStream();
будет желательно
Его лучше сохранить исходное значение аббревиатуры