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

Answer 2

使用{@code ...} Javadoc标签。
看这里：http://blog.smartkey.co.uk/2008/08/adding-xml-to-javadoc-comments/

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

2 个答案: