Wenn ich ein Stück Code oder Ressourcen fetch von etc Internet verwende, möchte ich dies in der Klassen- oder Funktionsdokumentation hervorheben und auch einen Link zur Originalquelle bereitstellen. Ich möchte jedoch auch beim Schreiben von Code für eine bessere Lesbarkeit an das Prinzip von maximal 80 Zeichen pro Zeile denken. Gibt es eine Möglichkeit, eine lange URL in der Quelle zu mehreren Zeilen zu analysieren und trotzdem die ursprüngliche Adresse als verwendbar zu erhalten, wenn das Javadoc in IDE wie Eclipse verwendet wird? Und mit benutzbar, bedeutet das Klicken auf die URL in javadoc Tooltip öffnet die richtige Seite.Eine lange URL zu mehreren Zeilen in javadoc brechen
Zum Beispiel, wie würden Sie das folgende Format:
/**
* Class to do some cool stuff
* Original source:
* http://stackoverflow.com/questions/and-huge-amouts-of-URL-address-which-does-not-fit-to-80-chars
*/
public class ExampleClass {
}
Ich glaube nicht. Verwenden Sie einen Linkverkürzer, vielleicht? Auf SO, fwiw, können Sie die URL nur bis zur Frage-ID verwenden. Zum Beispiel ist diese Frage bei http://stackoverflow.com/questions/41056517. – yshavit
* "Ich würde auch gerne beim Schreiben von Code für eine bessere Lesbarkeit an das Prinzip von maximal 80 Zeichen pro Zeile denken" * Es ist ein Grundsatz, kein Gesetz, das dich wegen Verletzung des Gesetzes ins Gefängnis schickt. Lange URLs sind nicht lesbar. Wenn Sie einen Link-Shortener verwenden, wird die Verknüpfung völlig unklar, d. H. Nicht lesbar. Also, was genau willst du lesbar machen? Was ist, wenn die Javadoc-Quelle eine lange Zeile mit einer URL hat, die sowieso nicht lesbar ist? Einfach das kompilierte Javadoc lesbar machen, wie [philantrovert zeigte] (http://stackoverflow.com/a/41056619/5221149). – Andreas
Ich weiß, es ist kein Gesetz, aber manchmal stößt man auf eine Sache wie diese und ich bin der Typ, der irritiert und neugierig ist, einen Workaround zu finden :) Aber ich werde mich jetzt mit verkürzten Links begnügen. Danke Leute! – pnkkr