インターネットからコードやリソースを取得している場合は、これをクラスまたは関数ドキュメントで指摘し、元のソースへのリンクも提供したいと思います。しかし、読みやすくするためにコードを記述する際には、1行に最大80文字を使用することをお勧めします。長いURLのソースを複数の行に解析し、EclipseのようなIDEでjavadocを使用する際に元のアドレスを使用可能に維持する方法はありますか?使用可能な場合は、javadocのツールチップのURLをクリックすると正しいページが開きます。例えばjavadocの長い行を複数行に分割する
、どのように次の書式を設定します:
/**
* 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 {
}
私はそうは思わない。おそらく、リンク短縮を使用しますか?それで、あなたは質問IDまでURLを使うことができます。たとえば、この質問はhttp://stackoverflow.com/questions/41056517にあります。 – yshavit
*「読みやすくするためにコードを書くときは、1行に最大80文字の文字列を使用したい」*違反して刑務所に送られる法律ではなく、原則です。長いURLは読み込みできません。リンクショートネーナを使用すると、リンクは完全にわかりにくくなります。だから、あなたは正確に何を読めるようにしようとしているのですか?では、javadocソースに長い行があり、URLが読み込めない場合はどうなりますか?ちょうど[philantrovertがあなたに示した]のように、コンパイルされたjavadocを読みやすくしてください(http://stackoverflow.com/a/41056619/5221149)。 – Andreas
私は法律ではないことを知っていますが、時にはこのようなことに遭遇する人もいます。私は苛立ちを感じ、回避策を見つけるのが好奇妙な人です:)しかし、私は今すぐ短縮されたリンクで解決します。みんなありがとう! – pnkkr