Сокращения в Camel Back

Я часто вижу имена классов Java, например

XmlReader

вместо

XmlReader

Чувство кишки - это полностью аббревиатуры верхнего регистра, но, по-видимому, многие люди думают иначе. Или возможно это только потому, что у многих генераторов кода возникают проблемы с акронимами...

Поэтому я хотел бы услышать общественное мнение. Как вы используете имена классов, содержащие аббревиатуры?

Ответы

Ответ 1

Мы используем соглашение о случае с верблюдом, такое как Java и .NET. Не по причинам генераторов кода, а для удобочитаемости. Рассмотрим случай объединения двух акронимов в одном имени, например класс, который преобразует XML в HTML.

XMLHTMLConverter

или

XMLHTMLConverter

Какой из них вы предпочитаете?

Ответ 2

Две причины:

  • Легче отличить, где заканчивается один аббревиатура, а другой начинается с идентификаторов, где они помещаются друг за другом, например, в XmlHtmlConverter. Теперь XML и HTML не являются такими хорошими примерами, потому что все знают, что такое XML, и что такое HTML. Но иногда вы увидите менее очевидные акронимы, а затем это становится важным.
  • Eclipse умный со словами и их инициалами. Для XmlHtmlConverter вы можете ввести XHC в диалоговом окне "Открыть тип", и он найдет его. Для XmlHtmlConverter инициалы будут XMLHTMLC, которые, конечно, немного длиннее.

Ответ 3

Я считаю, что XMLReader сложнее читать. Причина в том, что вы не можете легко определить, где слова разделены. Я считаю, что аббревиатуры с нижним регистром должны быть приняты. Вы можете использовать верхний регистр для определения классов, но как насчет переменных экземпляра:

XmlReader xmlReader;

Здесь вам все равно нужно использовать строчные буквы.

Ответ 4

Для аббревиатур я использую следующее правило:

  • Если аббревиатура имеет длину 2, поместите аббревиатуру в верхний регистр.

      For Ex : UIRule

  • Если акроним имеет большую длину, я использую паскаль для аббревиатуры

      For Ex : SmsValidation, XmlReader

Ответ 6

Я считаю, что, в общем, имена классов должны быть написаны так, как вы ожидаете, их читают. Например, при произнесении имени класса вслух я бы сказал "X-M-L reader", поэтому я бы назвал класс "XMLReader". Тем не менее, я бы назвал гипотетический класс "REST service" "RestService", так как в целом "REST" не произносится "R-E-S-T", а "отдыхает". Что-то вроде "SQL", я мог бы пойти в любом случае, поскольку некоторые люди говорят "S-Q-L", а другие говорят "сиквел". Но это действительно сводится к личным предпочтениям.