intellij-idea - 如何在 IntelliJ IDEA 的 Java 代码中插入 XML 注释？

Question

也许我遗漏了一些明显的东西，但我找不到使用 IntelliJ IDEA 编辑器(v. 12 社区版)在 Java 代码中插入 XML 注释的方法。

我正在谈论这样的评论:

/// <summary>
/// Encrypts plaintext using AES 128bit key and a Chain Block Cipher and returns a base64 encoded string
/// </summary>
/// <param name="plainText">Plain text to encrypt</param>
/// <param name="key">Secret key</param>
/// <returns>Base64 encoded string</returns>
public String encrypt(String plainText, String key) throws ...

Answer 1

将键盘插入符号放在您的方法上方。类型 /**然后按 ENTER。 Intellj 将创建一个模板 JavaDoc 注释，您可以在其中添加参数和返回值的描述，例如:

/**
 *  Encrypts plaintext using AES 128bit key and a Chain Block Cipher and returns a base64 encoded string  
 * 
 * @param plainText  Plain text to encrypt
 * @param key  Secret key
 * @return Base64 encoded string
 */
public String encrypt(String plainText, String key) throws ...

要查看带有格式化注释文本的弹出窗口，请将插入符号放入/** ... */并键入 Ctrl+Q