Hoe een klasse een naam te geven in Java

Dit artikel gaat over het kiezen van geschikte namen voor de klassen die u in Java schrijft. In theorie kun je elke klas een naam geven, zolang de taal dit maar ondersteunt. Het is echter beter om een aantal vooraf ingestelde regels te volgen, omdat anders mensen die uw code zien, denken dat u en uw werk "onprofessioneel" zijn, zonder zelfs rekening te houden met hoe goed u het algoritme hebt geïmplementeerd. Verrassend genoeg noemen zelfs studenten die op het punt staan hun studie af te maken, hun Java-klassen niet altijd op de juiste manier.

Inhoud

Stappen
Tips
Waarschuwingen

stappen

Titel afbeelding Name a Class in Java Stap 1

Het is het beste om een kort woord te gebruiken, wat een zelfstandig naamwoord moet zijn ("de naam van een ding"). Gebruik niet alleen een werkwoord of alleen een bijvoeglijk naamwoord.

Het geselecteerde woord moet het doel van de klas weerspiegelen.
Als het niet mogelijk is het doel van de klas duidelijk te omschrijven met alleen een zelfstandig naamwoord, voeg dan meer woorden toe met "CamelCase" -schrijven (zet de eerste letter van elk woord in hoofdletters, zoals BorderLayout). Bijvoeglijke naamwoorden zijn meer geschikt als aanvullingen, omdat ze van nature meer informatie over het zelfstandig naamwoord verschaffen.

Titel afbeelding Name a Class in Java Stap 2

Start de naam van de klasse altijd met een hoofdletter (dit is anders dan hoe de variabelen moeten worden genoemd).

Titel afbeelding Name a Class in Java Step 3

Gebruik geen onderstrepingstekens om meerdere woorden in de naam van een Java-klasse te scheiden (het is een programmeerregel in C ++).

Titel afbeelding Name a Class in Java Step 4

Het gebruikt alleen in hoofdletters geschreven namen als deze direct zijn gekoppeld aan een bekende afkorting (zoals URL, UUID, etc.).).

Titel afbeelding Name a Class in Java Stap 5

Plaats de lessen altijd in een pakket.

tips

Gebruik het voorvoegsel Abstract (hoe Abstracte tabel) om een abstracte klasse te noemen waaruit u later iets zult afleiden.
Gebruik het voorvoegsel Standaard (DefaultLayout) om een klasse een naam te geven die over het algemeen een standaardrol heeft, maar kan worden vervangen.
Gebruik het achtervoegsel Fabriek voor de klasse waarvan de hoofdfunctie is om instanties van een andere klasse te maken (zoals Bubble Factory, die instanties van produceert Bubble).
Gebruik het achtervoegsel Impl voor de klasse die een implementatie van een bepaalde interface is (zoals BubbleImpl breidt uit met Bubble-bel met abstracte bel).
Gebruik het achtervoegsel Uitzondering voor uitzonderingen en Fout voor fouten (zoals All Wrong Exception).
Vermijd zeer algemene namen zoals Gegevens of Algoritme, ze zeggen niet veel over de klas. Voeg enkele achtervoegsels of voorvoegsels toe om klassen specifieker te maken.
Het is beter om te voorkomen dat je cijfers in de namen van de klassen plaatst.

waarschuwingen

Gebruik geen underscores om klassen te benoemen, ongeacht de taal. Dit wordt alleen gebruikt als de klasse vrij overeenkomt met een standaard die officieel onderstrepingstekens in zijn naam heeft (zoals in de pakketten omg.org).
Het is handig om woorden in het Engels te gebruiken in plaats van woorden uit uw eigen taal. Engels is een standaardtaal voor internationale samenwerking, wat ook nodig is als het voor geen van beide partijen een moedertaal is.
Gebruik om dezelfde reden geen nationale letters die buiten de ASCII-dataset vallen. Zelfs als de ontwikkelomgeving dit ondersteunt.
Gebruik in geen geval het teken van pesos ($). Het is gereserveerd voor intern gebruik door de compiler.
Geef uw klas niet dezelfde naam als een klas uit een standaardbibliotheek of een ander type bibliotheek dat u gebruikt. Zelfs als de compiler dit toestaat als je het in een ander pakket stopt. Meerdere keren zijn er problemen geweest met betrekking tot een van deze fouten in de standaard API (java.awt.List en java.util.List)[1], [2].

Delen op sociale netwerken:

Verwant