User Interface Specification:
Javadoc AutoComment

Author: Gabriel Tichy
$Revision: 1.3 $
Table of Contents:


Introduction

The users would benefit from autogeneration of the JavaDoc comment skeleton to boost the productivity.

References

  • Feature #35666: Autogeneration of JavaDoc stub

System-Wide UI Impact

Design has no direct impact on any other existing feature.

Detailed Specification

If the user types
/** <enter>
the rest of the JavaDoc comment skeleton is generated:
/**
 * |
 */
Caret is moved on appropriate place.

If the user types "/** <enter>" before a method, the skeleton of the JavaDoc comment should also contain:

  • all the parameters (tag @param)
  • return tag (@return) if the method returns a value
  • thrown exceptions (tag @throws)

    according to the method.

    Example

    Before Enter:

    After Enter:

    Issues

     

  • Project Features

    About this Project

    ui was started in November 2009, is owned by Jiří Kovalský, and has 44 members.
    By use of this website, you agree to the NetBeans Policies and Terms of Use (revision 20160708.bf2ac18). © 2014, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo
     
     
    Close
    loading
    Please Confirm
    Close