Hoe om `n klas in Java te noem

Hierdie artikel gaan oor die keuse van toepaslike name vir die klasse wat jy in Java skryf. In teorie kan jy enige klas noem, solank die taal dit ondersteun. Dit is egter beter om vooraf bepaalde reëls te volg, want andersins kan mense wat jou kode sien, dink dat jy en jou werk onprofessioneel is, sonder om selfs rekening te hou met hoe goed jy die algoritme geïmplementeer het. Verrassend genoeg, selfs studente wat op die punt staan om kollege te voltooi, noem hul Java-klasse nie altyd behoorlik nie.

conținut

Stappe
Wenke
Waarskuwings

stappe

Prent getiteld Noem `n klas in Java Stap 1

Dit is beter om `n kort woord te gebruik, wat `n naamwoord (`die naam van `n ding`) moet wees. Moenie slegs `n werkwoord of `n byvoeglike naamwoord gebruik nie.

Die gekose woord moet die doel van die klas weerspieël.
As dit nie moontlik is om die doel van die klas duidelik te noem nie, gebruik slegs `n selfstandige naamwoord. Voeg nog meer woorde by met `CamelCase` skryfwerk (die eerste letter van elke woord in hoofletters, soos BorderLayout). Byvoeglike naamwoorde is meer geskik as aanvullings, aangesien hulle natuurlik meer inligting oor die naamwoord verskaf.

Prent getiteld Noem `n klas in Java Stap 2

Begin altyd die naam van die klas met `n hoofletter (dit verskil van hoe die veranderlikes genoem moet word).

Prent getiteld Noem `n klas in Java Stap 3

Moenie onderskrifte gebruik om verskeie woorde in die naam van `n Java-klas te skei nie (dit is `n programmeringsreël in C ++).

Prent getiteld Noem `n klas in Java Stap 4

Dit gebruik name wat in hoofletters geskryf is slegs indien hulle direk verband hou met `n bekende afkorting (soos URL, UUID, ens.).).

Prent getiteld Noem `n klas in Java Stap 5

Plaas die klasse altyd in `n pakket.

wenke

Gebruik die voorvoegsel Samevatting (hoe Abstrakte Tabel) om `n abstrakte klas te noem waaruit jy later iets sal aflei.
Gebruik die voorvoegsel Standaard (DefaultLayout) om `n klas te noem wat oor die algemeen `n verstekrol het, maar vervang kan word.
Gebruik die agtervoegsel Fabriek vir die klas waarvan die hooffunksie is om ander klasse te skep (soos Bubble Factory, wat gevalle van Borrel).
Gebruik die agtervoegsel Impl vir die klas wat `n implementering van `n koppelvlak is (soos BubbleImpl brei Abstrakte Bubble implementeer Bubble).
Gebruik die agtervoegsel Uitsondering vir uitsonderings en foute vir foute (soos Alle verkeerde uitsondering).
Vermy baie generiese name soos Data of Algoritme, hulle sê nie veel oor die klas nie. Voeg `n paar agtervoegsels of voorvoegsels by om klasse meer spesifiek te maak.
Dit is beter om te voorkom dat getalle in die name van die klasse geplaas word.

waarskuwings

Moenie onderskrifte gebruik om klasse te noem nie, maak nie saak wat die taal toelaat nie. Dit word slegs gebruik wanneer die klas byna `n standaard pas wat amptelik onderstreep in sy naam (soos in die pakkette omg.org).
Dit is gerieflik om woorde in Engels in plaas van woorde uit jou eie taal te gebruik. Engels is `n standaard taal vir internasionale samewerking, wat ook nodig is as dit nie `n moedertaal vir enige party is nie.
Om dieselfde rede, gebruik nie nasionale briewe wat buite die ASCII-datastel is nie. Selfs as die ontwikkelingsomgewing dit ondersteun.
Gebruik onder geen omstandighede die teken van pesos ($) nie. Dit word gereserveer vir interne gebruik deur die samesteller.
Moenie jou klas dieselfde naam gee as `n klas uit `n standaard biblioteek of ander soort biblioteek wat jy gebruik nie. Selfs as die samesteller dit toelaat as jy dit in `n ander pakket plaas. Verskeie kere was daar probleme wat verband hou met enige van hierdie foute in die standaard API (java.awt.List en java.util.List)[1], [2].

Deel op sosiale netwerke:

Verwante