akronimy w Camel Powrót

Question

często widzę nazw klas Java jak

XmlReader 

zamiast

XMLReader 

Moje przeczucie jest całkowicie górne przypadków akronimy, ale widocznie wiele osób uważa inaczej. A może dlatego, że wielu generatorów kodu ma problem ze skrótami ...

Chciałbym usłyszeć opinię publiczną. W jaki sposób zamieniacie kapitaliki w nazwy klas zawierające akronimy?

Answer 1

Używamy konwencji wielbłądów, takich jak Java i .NET do. Nie ze względu na generatory kodu, ale dla czytelności. Rozważmy przypadek łączenia dwóch akronimów w jedną nazwę, na przykład klasę, która konwertuje XML na HTML.

XMLHTMLConverter 

lub

XmlHtmlConverter 

Który wolisz?

Answer 2

Uważam, że XMLReader jest trudniejsze do odczytania. Powodem jest to, że nie możesz łatwo powiedzieć, gdzie słowa są rozdzielone. Uważam, że akronimy z małymi literami powinny być akceptowane. Możesz być w stanie używać dużych liter dla definicji klasy, ale co zmiennych instancji:

XmlReader xmlReader; 

Tu trzeba używać małych liter czy owak.

Answer 3

Dla akronimów używam następującą regułę:

• Jeżeli skrót ma długość 2, umieścić skrót w górnej części obudowy.

  For Ex : UIRule 
  

• Jeżeli skrót ma większej długości, używam pascal obudowę dla akronimu

  For Ex : SmsValidation, XmlReader 
  

Answer 4

dwóch powodów:

1. Łatwiej jest rozróżnić, gdzie kończy się jeden akronim, a drugi zaczyna się od identyfikatorów, w których są umieszczane jeden po drugim, na przykład w XmlHtmlConverter. Teraz XML i HTML nie są tak dobrymi przykładami, ponieważ każdy wie, czym jest XML i czym jest HTML. Ale czasami zobaczysz mniej oczywiste akronimy i wtedy staje się to ważne.
2. Eclipse jest inteligentny ze słowami i ich inicjałami. W przypadku XmlHtmlConverter można wpisać XHC w oknie dialogowym typu otwartego, aby go znaleźć. W przypadku XMLHTMLConverter inicjałami byłyby XMLHTMLC, co oczywiście jest nieco dłuższe.

Answer 5

Etui Pascal jest używane w środowisku .NET.Więc

XmlReader

jest korzystne w środowiskach Microsoft.

Muszę zgodzić się z AronVanAmmers, że jest to łatwiejsze do odczytania niż alternatywa.

referencyjny: Microsoft Design Guidelines for Class Library Developers

Answer 6

wierzę, że w ogóle, nazwy klas powinno być napisane jak można się spodziewać, żeby go odczytać. Na przykład, mówiąc głośno na nazwę klasy, powiedziałbym "czytnik X-M-L", więc nazwałbym klasę "XMLReader". Jednak nazwałbym hipotetyczną "usługę REST" klasy "RestService", ponieważ, ogólnie, "REST" nie jest wymawiane "R-E-S-T", ale "reszta". Dla czegoś takiego jak "SQL", mógłbym pójść w obie strony, ponieważ niektórzy ludzie mówią "S-Q-L", a inni mówią "sequel". Ale tak naprawdę sprowadza się to do osobistych preferencji.