Соглашения об именах для класса, содержащего аббревиатуру - PullRequest
4 голосов
/ 14 сентября 2011

Если я называю новый класс на языке ООП, что является лучшим соглашением:

  1. XMLWriter
    • Наиболее распространенный
  2. XMLwriter
    • Легче отличить
  3. XmlWriter
    • Больше не сокращенно
  4. XML_Writer
    • Удаляет точку верблюжьего футляра

Педантично да, но мне любопытно, кто что использует и почему.

Ответы [ 3 ]

5 голосов
/ 14 сентября 2011

Java-соглашения в последнее время, похоже, предпочитают трактовать общеизвестные сокращения как слова, поэтому: "XmlWriter" ...

http://www.ibm.com/developerworks/library/ws-tip-namingconv.html

Соглашение об именах Java с аббревиатурами <-dupe вопрос? </p>

http://geosoft.no/development/javastyle.html

Но, похоже, никто не очень последовательный. Возьмем для примера XMLHttpRequest в JavaScript. Что за крушение!

2 голосов
/ 14 сентября 2011

Я почти уверен, что все люди, имеющие разные соглашения об именах, захотят меня за это сказать. Но, по моему мнению, соглашение об именах, которое вы должны использовать, должно быть наиболее легким для чтения. Имена используются только людьми, поэтому они должны быть такими, какие легче всего читать / понимать. Так что для таких вещей, как XMLWriter, я бы, вероятно, назвал его XmlWriter, так как это кажется немного легче для чтения. Для вещей, которые очень распространены (например, XML), я думаю, лучше всего рассматривать это как слово. Если у вас есть какая-то аббревиатура, относящаяся к вашему домену, я мог бы использовать ее для своей выгоды, чтобы люди, которые не используют ее постоянно, понимали, что это аббревиатура. В основном, это облегчает понимание истинного намерения имен, даже если это немного затрудняет их чтение. Я думаю, что лучше руководствоваться здравым смыслом и здравым смыслом, чем придерживаться абсолютного набора правил именования. Несмотря на то, что в именах следует стараться, лучше всего следовать разумному набору соглашений об именах.

1 голос
/ 14 сентября 2011

Я бы сказал, что вы всегда должны предпочитать наиболее читаемый (как сказал молния) и, по крайней мере, начинать имя класса с заглавной буквы, как где-то я читал, что это стандартное соглашение Java, и я также чувствую, что начинание с заглавной буквы всегда делает Вы уверены, что это класс Java.

...