Standardized Comments for scripts
@@ -81,6 +81,32 @@ c:\ProgramData\TacticalRMM\
- Command Parameters are good. Optional command parameters for extra functions are better.
+- Add standardized Comment headers to scripts:
+```powershell
+<#
+.Synopsis
+ Short description
+.DESCRIPTION
+ Long description
+.EXAMPLE
+ Example of how to use this cmdlet
+.EXAMPLE
+ Another example of how to use this cmdlet
+.INPUTS
+ Inputs to this cmdlet (if any)
+.OUTPUTS
+ Output from this cmdlet (if any)
+.NOTES
+ General notes
+.COMPONENT
+ The component this cmdlet belongs to
+.ROLE
+ The role this cmdlet belongs to
+.FUNCTIONALITY
+ The functionality that best describes this cmdlet
+#>
+```
+
### Bad Habits
- Assumes non-standard configurations
