VSCode-Apex-Javadoc

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

VSCode-Apex-Javadoc

★ 11 Open GitHub ↗

Stubs a Javadoc Comment for a Salesforce Apex method based on the parameters in Visual Studio Code.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Apex Javadoc

[![Version](https://vsmarketplacebadge.apphb.com/version/btamburrino.apex-javadoc.svg)](https://marketplace.visualstudio.com/items?itemName=btamburrino.apex-javadoc)
[![Installs](https://vsmarketplacebadge.apphb.com/installs/btamburrino.apex-javadoc.svg)](https://marketplace.visualstudio.com/items?itemName=btamburrino.apex-javadoc)
[![Ratings](https://vsmarketplacebadge.apphb.com/rating/btamburrino.apex-javadoc.svg)](https://vsmarketplacebadge.apphb.com/rating/btamburrino.apex-javadoc.svg)

Stubs a Javadoc Comment for a Salesforce Apex method based on the parameters.

## Documentation

There are three ways to create a comment on an Apex method:
* On the line above the method signature, start typing `/**` and then hit tab
* While on the line that has the method signature, open the command bar and choose `Force: Stub Apex Javadoc Comment`
* Right click on the line with your method signature, and choose `Force: Stub Apex Javadoc Comment`
  * This requires you to have `force.showApexJavadocContext` set to `true` in your User Settings. This is `false` by default to not clutter up your context menu unless you want it to.
* If you see two instances of `*/` when using this, set `force.showApexJavadocTrailingCloseComment` to `false` in your User Settings.

## Known Issues

* If using the right-click context action on a class definition, the blank Javadoc comment is not whitespaced aligned with the beginning of the class definition. If you type `/**` and hit tab, it works as intended.
* You'll find more, I'm sure. Report them [here](https://github.com/btamburrino/VSCode-Apex-Javadoc/issues).

VSCode-Apex-Javadoc

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README