Правильный синтаксис для справки на основе комментариев .INPUTS / .OUTPUTS в powershell? - PullRequest
0 голосов
/ 26 февраля 2019

Я планирую использовать PlatyPS для онлайн-документации наших скриптов PowerShell.У меня проблема с синтаксисом .INPUTS и .OUTPUTS. Документация Microsoft гласит:

.INPUTS

Типы объектов Microsoft .NET Framework, которые можно передать в функцию или сценарий.Вы также можете включить описание входных объектов.

.OUTPUTS

Тип .NET Framework объектов, возвращаемых командлетом.Вы также можете включить описание возвращаемых объектов.

Но какой бы формат я ни пытался использовать в справке на основе комментариев, PlatyPS заканчивает тем, что принимает каждую целую строку как тип ввода или вывода, и никогда не бываетлюбое описание (как в Типе: "[OBJECT] Это описание типа", а также Описание: "").

Я пытался вникнуть в код PlatyPS: это немного над головой, но яв конечном итоге он подумал, что это даже не PlatyPS: именно так все выводится самим анализатором PowerShell.

Итак, вопрос: кто-нибудь знает, как форматировать справку на основе комментариев на входах и выходах, чтобы она понималась как типТОГДА описание?

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...