Écriture de fichiers d'aide Powershell

J'essaye d'écrire des fichiers d'aide pour un tas de modules PowerShell que j'ai écrits en C#. J'ai eu du mal à trouver quoi que ce soit aussi loin que cela, et ont essayé d'utiliser cet éditeur d'aideÉcriture de fichiers d'aide Powershell

https://pscmdlethelpeditor.codeplex.com/

mais je suis en train de travailler quelques bugs avec l'auteur. Longue histoire, il dit qu'il utilise PowerShell 2.0 et il essaie d'utiliser 3.0. Retour sur le sujet, j'ai besoin d'un moyen solide de savoir comment écrire des fichiers d'aide pour mes modules Powerhell C#. J'ai essayé suivant MSDN

http://msdn.microsoft.com/en-us/library/bb525433(v=vs.85).aspx

, mais soyons honnêtes, il est l'aide de Microsoft, ce qui est moins utile.

Source

2014-06-06 hoffmabo

Prenez une regardez [Aide] (https://github.com/nightroman/Helps). Je l'ai créé pour moi-même et utilisé pendant plusieurs années dans plusieurs projets. C'est inhabituel peut-être mais c'est vraiment utile. Et simple, en fait. –

@RomanKuzmin votre commentaire ressemble à une réponse à moi ... – BartekB

Comme vous l'avez constaté, les documents d'aide sur MSDN laissent beaucoup de place à votre imagination. Si vous aimez apprendre par exemple, vous pouvez consulter les fichiers d'aide pour les modules PowerShell existants:

$fs = Get-ChildItem C:\Windows\System32\WindowsPowerShell\v1.0\Modules -Recurse 
$fs |Where {$_.Name -like "*dll-Help.xml"} |Select FullName

Il vous donnera une meilleure idée sur la façon dont Microsoft utilisent eux-mêmes ce format

Source

2014-06-07 10:24:26

Écriture de fichiers d'aide Powershell

Répondre

Questions connexes