☁️ Salesforce Documenter ~ Beta ☁️
Salesforce Extensions for VSCode for language support.This extension depends on the official
Salesforce Documenter aims at facilitating proper and structured code documenting for Salesforce-related files, by automating related tasks such as File Header Insertion & Update, as well as Method Header insertion.
Salesforce Documenter can be adopted as a project-wide and/or team-wide standard, in an effort to encourage and eventually enforce proper code documenting.
Through these means, code becomes easier to understand, maintain, and evolve.
- Add a method header to any Apex method, with JavaDoc-Like tags to be completed with the method's and contextual details
|SFDoc: Generate Apex Method Header||Place cursor on the first line of a method declaration. Insert a method header based on the method's signature.||Apex Methods|
|SFDoc.username||Username that will appear in File and Method headers.|
|SFDoc.EnableForApex||Enable automatic on-save file header insertion and update for Apex classes|
|SFDoc.EnableForVisualforce||Enable automatic on-save file header insertion and update for Visualforce pages|
|SFDoc.EnableForLightningMarkup||Enable automatic on-save file header insertion and update for Lightning Markup files|