Sollten JUnit-tests werden javadocced?
Habe ich eine Reihe von JUnit-Testfällen, die derzeit nicht dokumentiert mit Javadoc-Kommentaren.
Den rest von meinem code ist dokumentiert, aber ich Frage mich, ob es überhaupt der Mühe Wert, zu dokumentieren, diese tests.
Du musst angemeldet sein, um einen Kommentar abzugeben.
Wenn der Zweck des Tests ist es naheliegend, dass ich nicht die Mühe, dokumentieren es.
Wenn es nicht so offensichtlich, weil es sich mit einigen obskuren situation - oder wenn ich will, um sich auf einen bestimmten bug, für Beispiel - in , dass Fall werde ich hinzufügen, Dokumentation. Ich glaube nicht, Dokument Ausnahmen werfen etc, obwohl - nur eine kurze Zusammenfassung der Methode. Dies geschieht relativ selten. Ich bin mehr wahrscheinlich, um Unterlagen für helper-Methoden, in mehreren tests.
Ich nicht finden, einen beliebigen Wert in javadocing der Testfälle. Ich mache nur die Methodennamen aussagekräftig genug, um zu wissen, den Zweck des Tests.
In Ruby, ich weiß, es gibt tools, um ein Dokument erstellen, aus dem Namen des tests, aber ich habe nicht gesehen, einer von diesen in Java.
Ob javadoc oder nicht, ich denke, dass unit-tests sollten auf jeden Fall dokumentiert werden. In Fällen, In denen keine formale Spezifikation existiert, die unit-tests sind das, was dem am nächsten kommt die Definition des erwarteten Verhaltens der code. Durch die Dokumentation der Testfälle, werden Sie machen es sehr klar für den Leser, was der test testet, und warum es zu testen.
Wenn Sie sich Gedanken über die tests als eine Dokumentation, es macht nicht viel Sinn, Sie zu "Dokument der Dokumentation". Die Namen der einzelnen Tests sollten an sich schon beschreiben, dass das, was ist der Zweck des tests - was ist das Verhalten wird angegeben, dass test.
Verwenden Sie lange, beschreibende Namen für die tests, und halten Sie den test-code so lesbar wie möglich.
Beispielsweise haben Sie einen Blick auf die test-Fälle in diesem Projekt. Weiß einer von Ihnen etwas tun, was nicht eklatant offensichtlich durch einen Blick auf den Namen des tests und dem test-code?
Es ist nur in einigen seltenen Fällen, wenn der test-code ist unklar,, die Kommentare sind notwendig tests. Zum Beispiel, wenn Sie den Test multi-threaded-code und test-code ist seltsam, die Dinge in Ordnung zu stellen Sie sicher, dass der Testcode läuft in der richtigen Reihenfolge. Aber selbst in jenen Fällen, ein Kommentar ist eine Entschuldigung nicht schriftlich Reiniger test-code.
Ich sehe nicht, warum sollten Sie behandeln Testfälle nicht anders als Ihre Produktions-code mit Bezug auf Kommentare.
Ich denke, es ist nützlich, um javadoc-die Bedingungen, unter denen die tests übergeben.
Ist es Ketzerei zu behaupten, dass code-Kommentare sind ein anti-pattern? Ich Stimme mit den oben genannten Antworten, im Idealfall würde der code beschreibend genug sein, um zu verlassen, ohne Kommentare. Dies gilt insbesondere, wenn Sie in einer (enterprise) Umfeld, wo Menschen neigen dazu, den code aktualisieren, ohne eine Aktualisierung Kommentare Kommentare werden in die Irre.
Hölle ja. auch wenn die nur...
Auftrag anlegen, Bearbeiten, Reihenfolge, speichern, laden & überprüfen Sie es.
wenn Ihr ein wirklich einfacher test, dann vielleicht nicht.
Finde ich die code-änderungen, die manchmal der Grund für den test ist nicht offensichtlich, wie es einmal war.
Vielleicht könnten Sie sich jemanden, der nicht ganz vertraut mit dem code, um Ihnen eine schnelle Rückmeldung, ob deine tests sind einfach zu verstehen, wie Sie sind.
In der Firma für die ich arbeite, versuchen wir, unseren tests beschreibende Namen und Dokument Komplexität, aber es ist oft schwer, dieses "Recht" mit dem ersten Entwurf, weil die Dinge, die offensichtlich für die Entwickler sind nicht immer offensichtlich zu anderen.
Tests behandelt werden wie code, der eingereicht wird, als Teil eines peer-review-Prozess, damit unsere (kleine) team Stellung nehmen können, ob ein test ist leicht zu verstehen, oder nicht.
Wenn ein test ist ein wenig verwirrend, wir können aktualisieren des namens oder der Dokumentation entsprechend und wir kommen sich mit einem besseren Messgerät, was funktioniert und was nicht.