Javaコメント構文

1.クイックスタート順不同リスト

/**
     * 这是一个用户登录方法
     * <h1>你要遵循以下几点要求</h1>
     * <ul>
     *   <li>雪碧</li>
     *   <li>可乐</li>
     *   <li>凉茶</li>
     * </ul>
     */
    public void login(){
    
    
        System.out.println("jaja ");
}

@Autowired
	UserService userService;

	@GetMapping("/")
	public void test(){
    
    
		userService.login();
	}

2.プレタグ

  テキスト形式を維持したい場合は、preタグを使用することがよくあります。たとえば、ソースコードを表示する場合は、preタグを配置し、ソースコードを直接コピーして貼り付けてから、形式を入力するだけです。ページ上で維持することができます。他のタグのように改行やスペースを自動的に折りたたむことはありません。preがどのように機能するかを見てみましょう。

HTMLのpre要素は、事前にフォーマットされたテキストを定義できます。pre要素のテキストは、スペースと改行を保持します。テキストは等幅フォントで表示されます。

例を見てみましょう。ここではcssコードを使用していますが、他のコードに変更することもできます。次のように：

body{
    
    
    background:#fff;
      font: 12px/24px 1.66;
}

プレで包むと

<pre>
body{
    
    
    background:#fff;
      font: 12px/24px 1.66;
}
</pre>

ブラウザで直接取得されます（注釈の原則は同じです）

上記のタブ、スペース、および改行が完全に保持されていることがわかります。

3.ltおよびgt

ltはより小さいの頭字語です
gtはより大きいの頭字語です

HTMLでは、特定の文字が予約されています。
HTMLで小なり記号（<）と大なり記号（>）を使用することはできません。これは、ブラウザーがそれらをタグと間違えるためです。
予約文字を正しく表示したい場合は、HTMLソースコードで文字エンティティを使用する必要があります

小なり記号を表示するには、次のように記述する必要があります。

/*
* <pre>
	 * &lt;c:url value="/login" var="loginProcessingUrl"/&gt;
	 * &lt;form action="${loginProcessingUrl}" method="post"&gt;
	 *    &lt;fieldset&gt;
	 *        &lt;legend&gt;Please Login&lt;/legend&gt;
	 *                &lt;c:if test="${SPRING_SECURITY_LAST_EXCEPTION != null}"&gt;
	 *                  Reason: &lt;c:out value="${SPRING_SECURITY_LAST_EXCEPTION.message}" /&gt;
	 *                &lt;/c:if&gt;
	 *            &lt;/div&gt;
	 *        &lt;/c:if&gt;
	 *        &lt;c:if test="${param.logout != null}"&gt;
	 *            &lt;div&gt;
	 *                You have been logged out.
	 *            &lt;/div&gt;
	 *        &lt;/c:if&gt;
	 *        &lt;p&gt;
	 *        &lt;label for="username"&gt;Username&lt;/label&gt;
	 *        &lt;input type="text" id="username" name="username"/&gt;
	 *        &lt;/p&gt;
	 *        &lt;p&gt;
	 *        &lt;label for="password"&gt;Password&lt;/label&gt;
	 *        &lt;input type="password" id="password" name="password"/&gt;
	 *        &lt;/p&gt;
	 *        &lt;p&gt;
	 *        &lt;label for="remember-me"&gt;Remember Me?&lt;/label&gt;
	 *        &lt;input type="checkbox" id="remember-me" name="remember-me"/&gt;
	 *        &lt;/p&gt;
	 *        &lt;div&gt;
	 *            &lt;button type="submit" class="btn"&gt;Log in&lt;/button&gt;
	 *        &lt;/div&gt;
	 *    &lt;/fieldset&gt;
	 * &lt;/form&gt;
	 * </pre>
	 *
	 * <h2>Impact on other defaults</h2>
	 *
	 * Updating this value, also impacts a number of other default values. For example,
	 * the following are the default values when only formLogin() was specified.
	 *
	 * <ul>
	 * <li>/login GET - the login form</li>
	 * <li>/login POST - process the credentials and if valid authenticate the user</li>
	 * <li>/login?error GET - redirect here for failed authentication attempts</li>
	 * <li>/login?logout GET - redirect here after successfully logging out</li>
	 * </ul>
	 *
	 * If "/authenticate" was passed to this method it update the defaults as shown below:
	 *
	 * <ul>
	 * <li>/authenticate GET - the login form</li>
	 * <li>/authenticate POST - process the credentials and if valid authenticate the user
	 * </li>
	 * <li>/authenticate?error GET - redirect here for failed authentication attempts</li>
	 * <li>/authenticate?logout GET - redirect here after successfully logging out</li>
	 * </ul>
	 */

4.{@link}与@see

コードを書くとき、あなたや他の人がそれを読むことができるときにあなたがあなたの関連するコードクラスか何かを直接見つけることができるように、コンテンツを互いに関連付けるためにいくつかのコメントを書く必要がある場合があります。
現時点では、{@ link}と@seeの2つのjavadocアノテーションが便利です。
どのような機能を持っていても、1つだけ処理しましょう。彼はコードをリンクして、コメントをより明確で理解しやすくすることができます。あなたと私にとって便利です。

@seeタグを使用すると、ユーザーは他のタイプのドキュメントを参照できます。具体的な使用法は次のとおりです。
@ see classname
@see full-qualified-classname
@see full-qualified-classname＃method name
@see full-qualified-classname＃attribute name

使っていたところ、頭に一行しか書けないことがわかりました。頭に書いてないと動かず、リンク効果もありません。
ただし、{@ link}これは自由に配置できます。
具体的な使用法は、上記の@seeと同じです。
実際の効果については、下の写真を参照してください。