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
  • 3 hours ago
  • 6 years ago

Installs

  • Total 12K
  • Win 9K
  • OS X 2K
  • Linux 641
Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22
Windows 3 8 3 3 3 0 1 3 6 6 5 4 0 2 4 5 6 4 6 3 3 5 5 8 6 3 2 4 3 6 1 1 6 1 3 3 5 4 4 2 1 0 3 7 7 7
OS X 0 0 0 1 2 0 0 0 1 0 0 1 0 0 5 0 1 0 1 0 0 0 0 0 2 1 0 0 0 0 1 1 0 0 0 0 1 1 2 1 1 0 0 0 2 1
Linux 0 0 0 0 1 0 0 0 0 1 0 1 0 0 0 2 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 2 0 0 0 0 1 0 0 0 0 0 0 1 1 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.