RubyMine 7.0.2 Web Help

Creating Documentation Comments

In this section:

Please note the following:

  • RubyMine checks syntax in the documentation comments and treats it according to the Error settings.
  • If the entered text contains HTML tags, the closing tag will be automatically added after typing >, provided that this behavior is enabled in the editor settings.
  • When typing in a documentation comment, the caret automatically moves to an expected position. For example:
    javadoc_smart_enter

To create documentation comments for a Ruby method

  1. Place the caret before the declaration of the method you want to document.
  2. Press Ctrl+Slash
  3. Press Ctrl+Space, and choose the desired tag from the suggestion list. Then press Ctrl+Space again, and choose the desired parameter name:
    ruby_createComment1

To create documentation comments for a Ruby method using intention action, do one of the following

  • Place the caret anywhere within the method you want to document, press Alt+Enter, and choose Add @return tag. The documentation comment with the @return tag is created. Specify the return type.
    ruby_createComment2.png
  • Place the caret at the parameter you want to document, press Alt+Enter, and choose Add @param tag. The documentation comment with the @param tag for the selected parameter is created. Specify the parameter type.
    ruby_createComment3

To create tags in a documentation comment block

  1. In a comment block, select the desired empty line and type @ or : character.
  2. Press Ctrl+Space, or just wait for Code Completion to display the suggestion list:
    doc_comment_tags
  3. Select a tag from the suggestion list. For example, you can specify the parameters type, or return type.
  4. If a certain tag has several values, press Ctrl+Space after the tag, and select the desired value from the suggestion list. For example, RubyMine suggests to select the desired parameter name.
    code_completion_param

Documentation comment can be created with the dedicated action Fix Doc Comment. It can be invoked by means of Find Action command.

Press Ctrl+Shift+A, with the caret somewhere within a class, method, function, or field, which should be documented, and enter the action name Fix Doc String. The missing documentation stub with the corresponding tags is added. For example:

function loadDocs(myParam1, myParam2){}

Type the opening documentation comment and press Enter to generate the documentation comment stub:

/** * @param myParam1 * @param myParam2 */

The next case lays with fixing problems in the existing documentation comments.

For example, if a method signature has been changed, RubyMine highlights a tag that doesn't match the method signature, and suggests an intention action UpdateJSDoc comment. You can also press Ctrl+Shift+A, and type the action name:

fix_doc_comment_js

Note that the action has no keyboard shortcut bound with it. You can do it as described in the section Configuring Keyboard Shortcuts.

See Also

Web Resources:

Last modified: 24 January 2015
comments powered by Disqus