Maybe I'm missing something obvious, but I can't find a way to enable insertion of XML comments in Java code using the IntelliJ IDEA editor (v. 12 community edition).
I'm talking about comments like this:
/// <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 ...
Place keyboard caret above your method. Type /**
then hit ENTER. Intellj will create a template JavaDoc comment to which you can add a description of parameters and return value , for example:
/**
* 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 ...
To see a pop-up window with the formatted comment text place the caret inside /** ... */ and type Ctrl+Q
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With