one or more lines that provide an overview of the method
@param param name
a description of what the parameter does
@return
a description of the return value from the method
@example
Example code usage. This will be wrapped in tags to preserve whitespace
/**************************************************************************************
* @description This method finds count of the given Fruit and returns it
* @param String - name - Fruit name
* @return Integer - Value retrieved .
* @example
* FruitService.getFruitsCount('mango')
**************************************************************************************/
public static IntegerI(String name) {
// ...
}
Check for comments in given folder with Apex classes
USAGE
$ sfdx mohanc:regex:apex:checkComments2 [-d <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --directoryname=directoryname Directory containing Apex Class
files
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLE
** Check for comments in given folder with Apex classes **
$ sfdx mohanc:regex:apex:checkComments2 -d <directory containing source code>
You can redirect the output to a file like this to open in your spreadsheet program