Skip to content
VSCode Extension To Produce Various File Header (Comments) for Files Associated with Salesforce
Branch: master
Clone or download
HugoOM Merge pull request #14 from HugoOM/hotfix_ExtraSpaceMethodHeaderNonCo…
…llectionParam

Fix - Removed extra space between argument type and name in Method he…
Latest commit 8c331f1 Mar 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
images
src
test_files/testFile_SFDXAutoheader Working settings migration | Commands scoping | WIP Commands conversi… Feb 28, 2019
.eslintrc.json Modified ESLint Config for ES8+ | Changed to async function | Templat… Dec 6, 2018
.gitattributes
.gitignore
.travis.yml WIP VF Support Dec 6, 2018
.vscodeignore initial Dec 6, 2018
CHANGELOG.md
LICENSE
README.md
jsconfig.json initial Dec 6, 2018
package-lock.json WIP Instructions | TBD Test Coverage Mar 3, 2019
package.json Fix - Removed extra space between argument type and name in Method he… Mar 22, 2019
tsconfig.json
tslint.json

README.md

️️☁️ Salesforce Documenter ~ Beta ☁️

Build Status Maintainability License: MIT marketplace

Important

This extension depends on the official Salesforce Extensions for VSCode for language support.

Summary

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.

Features

  • Add a method header to any Apex method, with JavaDoc-Like tags to be completed with the method's and contextual details

Method Header Demo

  • Add/Update a header to any Salesforce file (Apex, Visualforce, Aura, LWC, JavaScript)

File Header Demo

Commands

Command Description Applies To
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: Insert File Header Insert a file header at the top of the current file, if it doesn't already include one. Apex, Visualforce, HTML, JavaScript

Settings

Property Description
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
SFDoc.EnableForLightningJavascript Enable automatic on-save file header insertion and update for Lightning JavaScript files
You can’t perform that action at this time.