Quick Documentation
BashSupport Pro supports the quick documentation feature for variables, variable declarations, functions and commands.
Variables
All previous modifications of type and properties are tracked. This tracking until there’s no more declaration or until the the variable is unset.
Line comments, which immediately precede the first declaration, are displayed as documentation of that variable.
Supported types:
- String, this is the default and not displayed
- Array, e.g. by
declare -a - Associative Array, e.g. by
declare -A - Number, e.g. by
declare -i
Supported properties:
- Scope (Global or Local)
- Read–only, e.g. by
readonly - Exported, e.g. by
export
Variable Declarations
The documentation of variable declarations is similar to variables. Properties and type are first taken from the declaration itself and then merged with any previous declaration of the same variable.
Line comments, which immediately precede the first declaration, are displayed as documentation of that variable.
Functions
Quick documentation is available on the function name itself or on any invocation of that function.
Line comments, which immediately precede the declaration of the function, are displayed as documentation of that variable.
If the first comment follows the form name(param1,param2), then the parameters are displayed in the rendering.
Commands
For Bash’s built-in commands, BashSupport Pro displays the content returned by the help command for that particular command.
For other commands, BashSupport Pro displays the info page.