[JAVA] Verwenden Sie eine Beispieldomäne für den Paketnamen im Beispielcode

Überblick

Eine kleine Geschichte darüber, wie der Paketname des Beispielcodes lautet, der auf Qiit usw. veröffentlicht werden soll, ist gut. Es scheint gut, eine Beispieldomäne zu verwenden.

Benennungsmethode für Java-Pakete

Es ist ziemlich vertraut, daher ist es vielleicht unnötig zu sagen, aber vorerst. Es ist üblich, dass Java-Paketnamen die Domänennamen in umgekehrter Reihenfolge vorangestellt werden, um eine Duplizierung von FQCN zu vermeiden. In Die Java-Sprachspezifikation wird Folgendes als "Beispiel 6.1-1. Eindeutige Paketnamen" aufgeführt. [^ jspec].

Beispiel für einen Paketnamen


com.nighthacks.java.jag.scrabble
org.openjdk.tools.compiler
net.jcip.annotations
edu.cmu.cs.bovik.cheese
gov.whitehouse.socks.mousefinder

Beispielcode Paketname

Die auf Domainnamen basierende Benennung ist etwas übertrieben

Das Anwenden der obigen Regeln auf den Beispielcode wirkt jedoch etwas übertrieben. Ich habe die Anforderungen für den Paketnamen im Beispielcode kurz zusammengefasst.

Durch Umleiten der reservierten Domain eindeutig benannt

Also kam mir die Idee, die reservierte Domain umzuleiten. Reservierte Domains werden von IANA [^ iana] verwaltet und können je nach Zweck frei in Dokumenten usw. verwendet werden. Es sind vier Top-Level-Domains (TLDs) reserviert.

Reservierte TLD Verwenden
.test Domain zum Testen
.example Illustrative Domain
.localhost Domain für Loopback-Adresse
.invalid Domain, um ungültig anzuzeigen

Ist Beispiel und ungültig nicht genau richtig, um es im Paketnamen des Beispielcodes zu verwenden?

Beispiel


package example

public class SampleClass {
  // ...
}

abschließend

Bisher haben wir "com.example" [^ example-com] als Paketnamen verwendet, aber von nun an werden wir "example" verwenden. Sie können 4 Zeichen reduzieren.

Recommended Posts

Verwenden Sie eine Beispieldomäne für den Paketnamen im Beispielcode
Beispielquellcode zum Ermitteln des minimalen gemeinsamen Vielfachen mehrerer Werte in Java
Beispielcode, der die Moustache-Vorlagen-Engine mit Spring Boot verwendet
Beispielcode zum Aufrufen der Yahoo! Local Search API in Java
[Referenzbeispiel] Das Urheberrecht wird im Kommentar des Quellcodes beschrieben.
Beispielcode mit JMustache, der Moustache-Vorlagen-Engine in Java
Errate den Zeichencode in Java
Verwenden Sie das Findbugs-Plugin in Eclipse
Vorab geschriebener Quellcode für die Aktivität
Ich habe den Paketnamen überprüft, auf den die in der JAR-Datei enthaltene Klasse verweist
Ich möchte, dass Sie Enum # name () für den Schlüssel von SharedPreference verwenden
Quellcode zum Finden einer normalen orthogonalen Basis mit der Orthogonalisierungsmethode von Gram-Schmidt