ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Powershell Help Generator

by sponte ST2/ST3

Generates powershell help template for the the selected method name

Labels help doc

Details

  • 2013.10.15.14.08.51
  • github.​com
  • github.​com
  • 6 years ago
  • 52 minutes ago
  • 6 years ago

Installs

  • Total 11K
  • Win 9K
  • OS X 2K
  • Linux 611
Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8
Windows 3 3 1 3 0 3 3 1 2 0 0 3 6 2 8 2 2 1 8 5 5 8 2 1 3 6 4 6 5 2 1 4 6 8 2 9 1 4 6 8 1 3 5 3 6 1
OS X 0 2 0 0 1 2 0 0 0 0 0 0 2 0 1 0 0 1 1 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0 0 0 1 0 1 0 2 0 2 0 1 1
Linux 0 3 0 0 0 0 0 0 0 0 1 0 1 0 1 0 0 0 1 1 1 0 0 0 0 0 0 1 0 0 0 1 0 1 0 0 1 0 0 0 0 0 0 2 0 0

Readme

Source
raw.​githubusercontent.​com

sublime_powershell_help

Generates powershell help template for the the selected method name

Installation

Clone repository to your packages directory

Sublime 2: %APPDATA%\Sublime Text 2\Packages Sublime 3: %APPDATA%\Sublime Text 3\Packages

git clone https://github.com/sponte/sublime_powershell_help.git "%APPDATA%\Sublime Text 3\Packages\sublime_powershell_help"

Usage

Put your cursor on the line where your cmdlet is, press CTRL + SHIFT + P and find Document Cmdlet command. Once you run it it will preped documentation template above the function.

Notes

Your method needs to be discoverable to powershell i.e. it needs to be a exported method in the module that is on the PSModulePath.

Currently there is no error handling and verification. It will prepend documentation twice if you call it twice on the same method.