How To Add Javadoc Comments In Netbeans

The editor helps you quickly consummate or generate code through the "smart" lawmaking completion characteristic. Lawmaking completion is very useful when you want to fill in missing lawmaking, it allows you to await at the bachelor options within the context of your application, and generates fragments of lawmaking when required. See below for examples of how to use code completion.

Invoking Code Completion

To invoke code completion press Ctrl+Space or, cull Source > Complete Lawmaking… from the card bar and a list of advisable suggestions is presented to you. Equally y'all continue to type, code completion becomes more focussed and the list shortens. The listing includes options imported in your source file and symbols from the coffee.lang package.

To customize the code completion settings, select:

Windows ™

Tools > Options > Editor > Code Completion

macOS ™

NetBeans > Preferences… > Editor > Code Completion

You tin can set code completion to pop-up an options list either automatically or, on an as-needed basis. In the Code Completion pane for Language: All Languages, select the Auto Popup Completion Window checkbox to invoke code completion automatically when you type certain characters. The default character for Language: Coffee is " . ", but you can add together your own characters.

To add characters that will invoke code completion, select the Language: Java pane and type your characters in the Car Popup Triggers for Coffee: field. The code completion listing will pop-upwardly every time you type one of your specified characters, simply select your desired choice, hit return or "double-click", for it to be entered into your certificate.

When the Auto Popup Completion Window checkbox is not selected, you need to press Ctrl+Space each time y'all want to invoke lawmaking completion.

Instead of using Ctrl+Infinite for code completion, you tin can use "hippie completion". Hippie completion analyzes text in the visible scope past searching your current certificate and, if non found, in other documents. Hippie completion so provides suggestions to complete the current discussion with a keyword, class proper name, method, or variable. To invoke hippie completion press:

Windows™/Linux

Ctrl+M

macOS™

Command+G

and the editor automatically completes the word you're typing. Repeatedly pressing the appropriate key combination will cycle in one case through all available options. If you go past your desired option then press the shift key every bit well equally your fundamental combination and you can reverse.

The commencement time Ctrl+Space is pressed only items matching the blazon, in this example an int, are shown.

codecompletion3

Printing Ctrl+Infinite a second time and all available items are shown, regardless of whether they match the provided type, as shown below.

codecompletion4

Also, you can select for Language: Java the Machine Popup on Typing Any Coffee Identifier Function checkbox and, as you type keywords etc., code completion automatically presents you with an appropriate list of options.

Smart Suggestions at the Top

Lawmaking completion is "smart", and volition present the nigh relevant suggestions at the top, above the black line in the code completion list.

In the example below, the editor suggests inserting the LinkedHashMap constructor from the coffee.util package.

smartcompletion1

If the "smart" suggestions are non the ones you lot want to utilize, press Ctrl+Space once again to see the complete list.

Camel Example Completion

Instead of typing consecutive characters, and so calling lawmaking completion, yous can type the initial capital letters of the word you're interested in.

For example, type IE , press Ctrl+Infinite , and y'all will see a list of suggestions that match via camel case completion using the letter I and so the letter East .

camelcase

Completing Keywords

Use lawmaking completion to consummate keywords in your code. The editor analyzes the context and suggests the most relevant keywords.

In the example below, the ColorChooser class needs to extend the JPanel class. You can rapidly add the keyword extends from the suggested items.

keywords

Suggesting Names for Variable and Fields

When y'all are calculation a new field or a variable, utilize lawmaking completion to choose a proper noun that matches its blazon.

Type a prefix for the new proper noun, printing Ctrl+Infinite and select the name you want to use from the listing of suggestions.

names

Suggesting Parameters

The editor determines the well-nigh likely parameters for variables, methods, or fields and displays the suggestions in a popular-upwards box.

For example, when you select a method from the lawmaking completion window which has ane or more arguments, the editor highlights the first argument and displays a tooltip suggesting the format for this statement. To move to the side by side statement, press the Tab or Enter keys.

Y'all tin can invoke the tooltips with method parameters by pressing:

Windows™/Linux

Ctrl+P

macOS™

Command+P

or, selecting Source > Show Method Parameters from the menu bar at any fourth dimension.

parameter

Common Prefix Completion

You tin can use the Tab key to quickly fill in the most unremarkably used prefixes and single suggestions. To check out how this characteristic works, effort typing the post-obit:

Type System.out.p and await for code completion to testify all fields and methods that outset with "p". All the suggestions will exist related to "print".

prefixcompletion

Press the Tab primal and the editor automatically fills in the "print". Yous can proceed and blazon "l" and, after pressing Tab again, "println" will be added.

Subword Completion

Sometimes you may not remember how an detail starts, making it hard to employ code completion. For example, to meet all items that relate to listening to property changes, you can utilize subword completion, so if yous blazon prop you will see all method calls that relate to property change listening.

subcompletion

To implement this characteristic, select:

Windows™/Linux

Tools > Options > Editor > Code Completion

macOS™

NetBeans > Preferences… > Editor > Lawmaking Completion

then select in the Language: Coffee pane, the Subword completion checkbox.

You can and then type function of the method you desire to telephone call, in this case prop, then invoke code completion, relevant alternatives all applicative to properties on the object, in this instance, are displayed.

Chain Completion

When you need to type a concatenation of commands, you tin can use lawmaking completion. By pressing Ctrl+Infinite twice all available chains will exist shown. The editor scans: variables, fields, and methods that are in the visible context. It will then suggest a chain that satisfies the expected type.

chain

Completion of Static Imports

When you want to consummate a argument and, at the aforementioned time, require to make use of a static import statement, use code completion. Past pressing Ctrl+Infinite twice, all available static import statements will be shown.

static

If yous would like static import statements to be added automatically, select:

Windows™/Linux

Tools > Options > Editor > Formatting

macOS™

NetBeans > Preferences… > Editor > Formatting

then from the Language: Java, Category: Imports pane select the Prefer Static Imports checkbox.

Excluding Items from Completion

Time can be wasted when code completion returns classes that yous seldom or never apply. When you invoke code completion, a lightbulb within the returned items indicates that you can exclude them from the code completion list.

exclude2 small

You can add or change your exclusion rules either when "Configure excludes" is selected from the code completion list or, by selecting:

Windows™/Linux

Tools > Options > Editor > Code Completion

macOS™

NetBeans > Preferences… > Editor > Code Completion

and then in the Language: Coffee pane, make your changes to the Packages/classes: list.

exclude

JPA Completion

When yous are using the Java Persistence Note specification (JPA), you can consummate SQL expressions in @NamedQuery statements via code completion.

jpacompletion

In the code completion window, icons are used to distinguish different members of the Java language. Run across Appendix A: Icons in the Lawmaking Completion Window at the end of this certificate to run into the meanings of these icons.