Vor kurzem habe ich daran gearbeitet, Teile der Codebasis, mit denen ich mich derzeit befasse, zu überarbeiten - nicht nur, um sie selbst besser zu verstehen, sondern auch, um es anderen zu erleichtern, die an dem Code arbeiten. Ich neige dazu, mich auf die Seite des Denkens zu lehnen, dass...
Gibt es einen guten Begriff, der ähnlich, aber anders als "veraltet" ist, um zu bedeuten, dass sich eine Methode oder API in der Codebasis befindet, aber nicht verwendet werden sollte, weil ihre Implementierung nicht vollständig ist oder sich wahrscheinlich ändern wird? (Ja, ich weiß, diese...
Im JavaDoc X509Certificate getSubjectDN()heißt es: Verunglimpft , ersetzt durch getSubjectX500Principal (). Ich bin es gewohnt, in den for-Methoden "Veraltet" zu sehen, die nicht mehr verwendet, aber nicht verunglimpft werden sollten. Ich habe einen Fehlerbericht über diesen speziellen Fall...
Ich möchte Javadoc auf trockene Weise schreiben. Aber das Orakel-Dokument über Javadoc sagt, dass man dasselbe noch einmal in einen Kommentar zur Überladungsmethode schreiben soll. Kann ich Wiederholungen nicht
Ich arbeite an einer kleinen Bibliothek, die Implementierungen grundlegender, bekannter String-Metriken bereitstellt. Meistens für meine eigene Ausbildung. Die Entwicklung findet also immer dann statt, wenn ich etwas Freizeit habe. Aus diesem Grund habe ich die meisten Prozesse automatisiert,...
Was wäre eine gute Alternative zur Inline-Java-Dokumentation, dh kann man eine separate Dokumentdatei haben, die irgendwie einer Java-Quelldatei zugeordnet ist? Ich habe noch nie große Kommentarbereiche mit Code
Ich bin gerade in einem Laborhandbuch an der Universität auf Folgendes gestoßen: Sie müssen die Schnittstellen der Klassen studieren, indem Sie das Javadoc für sie generieren, damit Sie wissen, welche Operationen bereitgestellt werden (Sie können sich den Code ansehen, aber wenn Sie wie hier den...