none
Comment Based Help for Modules

    Question

  • I have modules for a library of functions that are saved with a psm1 extention. I can get comment-based help to work for .ps1 files but not .psm1. Am I mssing something or do I need to implement help in some other fashion.
    Tuesday, May 15, 2018 7:03 PM

Answers

  • Hello and welcome to the Powershell forum.

    Did you review the help for Comment Based Help? To get this information in the console or in the ISE you can run one of the following commands:

    Get-Help about_comment_based_help -ShowWindow
    Get-Help about_comment_based_help -Full
    Get-Help about_comment_based_help -Online



    Best regards,

    (79,108,97,102|%{[char]$_})-join''

    • Marked as answer by MDingas Thursday, May 17, 2018 7:56 PM
    Tuesday, May 15, 2018 7:32 PM

All replies

  • Hello and welcome to the Powershell forum.

    Did you review the help for Comment Based Help? To get this information in the console or in the ISE you can run one of the following commands:

    Get-Help about_comment_based_help -ShowWindow
    Get-Help about_comment_based_help -Full
    Get-Help about_comment_based_help -Online



    Best regards,

    (79,108,97,102|%{[char]$_})-join''

    • Marked as answer by MDingas Thursday, May 17, 2018 7:56 PM
    Tuesday, May 15, 2018 7:32 PM
  • Yes I read the help file. but I missed that short entry about xml files. So I understand that I need to create an external xml file and reference it in the module. Now I have to figure out how to write an xml help file! Thanks for the help.


    • Edited by MDingas Thursday, May 17, 2018 7:57 PM more complete
    Thursday, May 17, 2018 7:55 PM