如何在Java中添加评论框？

Question

I am working on a project in java for class and I need to add a comment box above each of my methods explaining what each method does. It's supposed to look like this:

***** *** ** ** ** (asterisk line) ************************************************************************* *@param

*

**** *** ** ** ** **(another line) *********************************************************************

I am using eclipse and I know there is a shortcut that makes this box but I can't seem to remember it or find it on the web...

Answer 1

Goto eclipse > windows > preference > java > templates

click NEW now give name for your pattern and add description and provide below pattern

/*****************************************************************************************
* ${cursor}This is default description for this method. Kindly remove this type the actual 
* usage and other relevant information for the method as description.
* @since    ${date}
* @param    paramName   Parameter description 
* @return   <Description of return value. Remove this tab for return type     void.>
* @throws   ExceptionClass  Description of the exception reason or  scenario
*****************************************************************************************/

/*
* Author    ${user}
* Version   <Enter the version of the product/project for this method.> 
* History   Updated By      Update Date     Update Reason
*           ==============  ===========     ================================================
*/

use context as java and now final show down create any class and than add method before introducing a method just start typing the name of the above template and than press CTRL+SPACE and select your template and boom your method is read for description.

Answer 2

在主菜单中，窗口->首选项在左侧的树中，Java->代码样式-> CodeTemplates在右侧面板上，选择注释->方法，然后在右下方的文本区域中打印图案

Answer 3

It is good practice to use JavaDoc to document each of your methods and explain what they do, their parameters, what they return, and any exception it may throw.

/**
 * This is proper JavaDoc notation. It starts with a forward slash, two asterisks
 * and then an asterisk per line. When it ends, we use the combo asterisk forward slash
 */

When identifying parameters and return types, use the @ character:

/**
 * method add2 takes an integer and adds
 * 2 to it. It then returns the new integer
 *
 * @param someInt    the integer we will add 2 to
 * @return integer   the new integer after 2 was added
 */
public int add2(int someInt) {
    int integer = someInt + 2;
    return integer;
}