Reguläre Ausdruck

[Wirtschaftsinformatiker]

Ist mein Code richtig?

public class RegEx
{
    /**
     * Eine Methode, die wahr zurückgibt, wenn ein
     * übergebener String der Klassenkonvention entspricht.
     * @param className ein beliebiger String ungleich null
     * @return true oder false.
     */
    public boolean  className (String className ){

        return className.matches("[A-Z][a-zA-Z0-9_]*");

    }

    /**
     * Eine Methode, die wahr zurückgibt, wenn ein
     * übergebener String der Methodenkonvention entspricht.
     * @param methodName ein beliebiger String ungleich null
     * @return true oder false.
     */
    public boolean methodName (String methodName ){

        return methodName.matches("(_?[a-z]([a-zA-Z0-9]+)?)");

    }

    /**
     * Eine Methode, die wahr zurückgibt, wenn ein
     * übergebener String der Feldkonvention entspricht.
     * @param feldName ein beliebiger String ungleich null
     * @return true oder false.
     */
    public boolean feldName (String feldName){

        return feldName.matches("(_?[a-z]([a-zA-Z0-9]+)?)");
    }

}

 

[KonradN]

Ist mein Code richtig?

Hinweis Lesbarkeit: Was macht eine Methode className? Methoden sollten ein Verb haben, damit der Name direkt aussagt, was die Methode macht. isClassName wäre dann z.B. besser.

Funktionalität: Hast Du die Methoden denn getestet? Dann solltest Du wissen, ob diese das gewünschte Ergebnis bringen. Da wird die Anforderungen nicht kennen, können wir nicht sagen, ob es richtig oder falsch ist.

 

[Wirtschaftsinformatiker]

Hinweis Lesbarkeit: Was macht eine Methode className? Methoden sollten ein Verb haben, damit der Name direkt aussagt, was die Methode macht. isClassName wäre dann z.B. besser.

Funktionalität: Hast Du die Methoden denn getestet? Dann solltest Du wissen, ob diese das gewünschte Ergebnis bringen. Da wird die Anforderungen nicht kennen, können wir nicht sagen, ob es richtig oder falsch ist.

Die reguläre Ausdrücke wie +, * oder _ habe ich richtig verwendet?
Kann einen Unterstrich am Anfang der Methodenname oder Feldnamen vor kommen?

 

[Wirtschaftsinformatiker]

Hinweis Lesbarkeit: Was macht eine Methode className? Methoden sollten ein Verb haben, damit der Name direkt aussagt, was die Methode macht. isClassName wäre dann z.B. besser.

Funktionalität: Hast Du die Methoden denn getestet? Dann solltest Du wissen, ob diese das gewünschte Ergebnis bringen. Da wird die Anforderungen nicht kennen, können wir nicht sagen, ob es richtig oder falsch ist.

Ich habe auch eigene Junit Test geschrien. Ist das richtig?

public class RegExTest
{

    RegEx regEx = new RegEx();

    @Test
    public void testKlassennameNegativ(){

        assertFalse(regEx.className("klasse"));
    }

    @Test
    public void testKlassennamePositiv(){

        assertTrue(regEx.className("Klasse2"));
    }

    @Test
    public void testMethodNameNegativ(){

        assertFalse(regEx.methodName("Methode"));
    }

    @Test
    public void testMethodNamePositiv(){

        assertTrue(regEx.methodName("methode"));
    }

    @Test
    public void testFeldNameNegativ(){

        assertFalse(regEx.feldName("Feld"));
    }

    @Test
    public void testFeldNamePositiv(){

        assertTrue(regEx.feldName("feld2"));
    }

}

 

[KonradN]

Ich habe auch eigene Junit Test geschrien. Ist das richtig?

Da wäre meine Antwort ganz klar: NEIN. Nicht, weil da direkt Fehler auffallen, sondern weil die Tests ja kaum etwas testen. Vor allem wenn Du selbst Fragen stellst wie:

Kann einen Unterstrich am Anfang der Methodenname oder Feldnamen vor kommen?

Entweder das ist eine Frage der Anforderung. Die kennen wir nicht! Wenn es um reine Java Regeln geht, dann wären das die Regeln für Bezeichner in Java. Da wäre dann die JLS zu prüfen: https://docs.oracle.com/javase/specs/jls/se19/html/jls-3.html#jls-3.8
Oder geht es um Naming Conventions? Das würde erklären, dass Du keien Umlaute erlaubst in Klassennamen (aus Java Sicht ok!) und mit einem großen Buchstaben starten willst. Aber ein _ ist in Klassennamen eigentlich auch nicht vorgesehen, da man ja ein Upper Camelcase verwendet.

Oder es ist eine Frage der Funktionalität. Dazu dienen die Unit Tests. Die Unit-Tests müssen zeigen, dass die Anforderungen erfüllt sind. (Sauber geschriebene Unit Tests sind dann eine Form der Dokumentation der Anforderungen!)

==> Daher: Ich habe keine Ahnung von den Anforderungen. Daher kann ich nicht sagen, ob die regulären Ausdrück korrekt sind. Wenn Dir die Anforderungen vorliegen, dann kannst (und musst!) Du diese explizit prüfen in Deinen Unit Tests.

 

[Wirtschaftsinformatiker]

Da wäre meine Antwort ganz klar: NEIN. Nicht, weil da direkt Fehler auffallen, sondern weil die Tests ja kaum etwas testen. Vor allem wenn Du selbst Fragen stellst wie:

Entweder das ist eine Frage der Anforderung. Die kennen wir nicht! Wenn es um reine Java Regeln geht, dann wären das die Regeln für Bezeichner in Java. Da wäre dann die JLS zu prüfen: https://docs.oracle.com/javase/specs/jls/se19/html/jls-3.html#jls-3.8
Oder geht es um Naming Conventions? Das würde erklären, dass Du keien Umlaute erlaubst in Klassennamen (aus Java Sicht ok!) und mit einem großen Buchstaben starten willst. Aber ein _ ist in Klassennamen eigentlich auch nicht vorgesehen, da man ja ein Upper Camelcase verwendet.

Oder es ist eine Frage der Funktionalität. Dazu dienen die Unit Tests. Die Unit-Tests müssen zeigen, dass die Anforderungen erfüllt sind. (Sauber geschriebene Unit Tests sind dann eine Form der Dokumentation der Anforderungen!)

==> Daher: Ich habe keine Ahnung von den Anforderungen. Daher kann ich nicht sagen, ob die regulären Ausdrück korrekt sind. Wenn Dir die Anforderungen vorliegen, dann kannst (und musst!) Du diese explizit prüfen in Deinen Unit Tests.

Es geht nur um Naming Convention, wie die Namen geschrieben werden und mithilfe von regulären Ausdrücken zeigen, welche Namen bei Methode, Klasse und Felder erlaubt sind

 

[KonradN]

Es geht nur um Naming Convention, wie die Namen geschrieben werden und mithilfe von regulären Ausdrücken zeigen, welche Namen bei Methode, Klasse und Felder erlaubt sind

Dann kannst Du schauen:

https://www.oracle.com/java/technologies/javase/codeconventions-namingconventions.html

Ist nicht wirklich so exakt beschrieben, aber da ist mein Verständnis, dass da kein "_" etwas verloren hat.
Ebenso bei den Methoden.

Aber zur Not hast Du Deine Auslegung. Diese solltest Du dann aber in den Unit Tests klar dokumentieren und entsprechend testen.

Bei den Tests kannst Du Dir ja den Regulären Ausdruck nehmen und die möglichen Kombinationen testen und dann auch schauen, dass alle Abweichungen wirklich zu einem nicht erkennen führen.