GenerApex README

The extension is intended to simplify the work with sfdx and the apex language when developing on Salesforce. This will allow you to generate any type of apex classes, provide new tools and capabilities for the code editor, add new snippets for generating documentation.

Synebo Create commands (Ctrl+Shift+P):

SBC: Apex class

Parameters: Class name, Path. Description: Creates Apex class with the specified name.

SBC: Batch Apex class

Parameters: Class name, Path, sObject name, Batch type, Additional functionality Description: Creates Batch Apex class with the specified name, SObject name, Batch type and interfaces. Contains start, execute and finish methods.

SBC: Queueable Apex class

Parameters: Class name, Path, Additional functionality Description: Creates Queueable Apex class with the specified name and interfaces. Contains empty execute method.

SBC: Scheduler Apex class

Parameters: Class name, Path Description: Creates Schedulable Apex class with the specified name. Contains empty execute method.

SBC: Test Apex class

Parameters: Class name, Path Description: Creates Test Apex class with the specified name. Contains @testSetup and @isTest methods.

SBC: Interface Apex class

Parameters: Class name, Path Descrition: Creates empty Apex Interface with the specified name.

SBC: Lightning controller Apex class

Parameters: Class name, Path Description: Creates public with sharing class with the specified name. Contains @AuraEnabled public static method.

SBC: REST Apex class

Parameters: Class name, Path Description: Creates global with sharing class with the specified name. Class is annotated as RestResource with specified urlMapping address. Contains REST methods (get, post, delete) which can be selected while class created.

SBC: Generate constructor

Parameters: Class attributes Description: Step 1. Select the class attributes that you want to use as parameters for the constructor. Step 2. Call comand to generate constructor with this set of attributes. If there no attributes selected, then will created default class constructor (without parameters).

SBC: Generate getters and setters

Parameters: Class attributes Description: Step 1. Select the class attributes that you want to add getter and setter. Step 2. Call the command.

SBC: Rename refactoring

Parameters: Any name - class, method, variable. Description: Step 1. Select the word you want to change (class, method, variable). Step 2. Call the command. Step 3. In the window that appears, enter the change and confirm (Enter key).

SBC: Override and Implements Methods

Parameters: Call the command to implement the added interfaces. Description: Implements added interfaces

Snippets:

(What are snippets in VS code?)

Default prefix: !! Settings > Extensions > Snippets for Salesforce Developers and modify the Prefix value

Apex callout description: Generation of a call to the REST service

doc method description: Add a new block comment for your method. The comment includes basic information about your method explained with different tags. By default, it will include the name, author, created, description, param and return tags. Other additional tags can be included inside this comment

doc class description: Add a new block comment for your class. The comment includes basic information about your class explained with different tags. By default, it will include the name, author, created, description and a changelog with version tags. Other additional tags can be included inside this comment

doc @name description: Add a new @name tag for your class and method comments. It represents the name of your class or method

doc @author description: Add a new @author tag for your class and method comments. This includes the name and the email of the author. By default, these values will be filled automatically if there is an existing git cofiguration for the current project

doc @created description: Add a new @created tag for your class and method comments. This indicate the date when the code was originally created. By default, the date will be filled automatically to today

doc @description description: Add a new @description tag for your class and method comments. You can provide an explanation of what your code does

doc @version description: Add a new @version tag for your class comments. This refers is used to generate a change log, in which every contribution specifies the version, the date, the author and a description of the changes done

doc @param description: Add a new @param tag for your method comments. Multiple @param lines can be included, and each of them will include its object type and name

doc @return description: Add a new @return tag for your method comments. This option describes what is returned in your method. Omit this tag for methods that returns void

doc @exception description: Add a new @exception tag for your method comments. This contains the type and a description of the exception that can potentially be thrown from your method

doc @deprecated description: Add a new @deprecated tag for your class and method coments. You can provide a description of why this code has been deprecated, in which API version and whether it has been replaced by another functionality Aura doc auradoc structure description: Create the basic structure for the auradoc file

doc title description: Insert a title in your auradoc description

doc paragraph description: Insert a paragraph in your auradoc description

doc inline code description: Insert an inline block of code in your auradoc description

doc link description: Insert a link to a URL in your auradoc description

doc code block description: Insert a full code of block inside your auradoc description

doc bulleted list description: Insert a bulleted list in your auradoc description

doc numbered list description: Insert a numbered list in your auradoc description

doc table description: Insert a table in your auradoc description

doc aura:example description: Create a new example reference in your auradoc