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

Powershell Help Generator

by sponte ALL

Generates powershell help template for the the selected method name

Labels help doc

Details

  • 2013.10.15.14.08.51
  • github.​com
  • github.​com
  • 11 years ago
  • 28 minutes ago
  • 11 years ago

Installs

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