在 powershell 脚本中嵌入 doxygen 文档

问题描述 投票:0回答:0

我想制作一个带有漂亮文档的 PowerShell 模块或脚本。 PowerShell 文档被写入评论块,如下所示:

<#   
    .SYNOPSIS
    My module does a nice job.
    .DESCRIPTION
    The author has written a lot of code than you can enjoy.
    .PARAMETER
    Yes, we got parameters.
    .EXAMPLE
    Here we are: call it.
#>

可以使用 PowerShell get-help cmdlet 阅读文档。

现在我想生成一个doxygen文档。希望 doxygen 像 C 文件一样解析这个类似的文件,我更改了注释并添加了一些标签:

<##
    @overview
    .SYNOPSIS
    My module does a nice job.
    @version 08.15
#>

我还更改了 Doxyfile:

FILE_PATTERNS          = *.psm1

所以 doxygen 读取这个文件:

解析文件
阅读 D:/Projects/Tools/Scripts/MakeDelivery/MakeDelivery.psm1...
构建组列表...

PowerShell 文件出现在生成的 HTML 文档的文件列表中,但根本没有任何文本。使用 doxygen 创建可在 PowerShell 外部阅读的文档需要什么? 应尽可能使用可用的文档。

powershell doxygen
© www.soinside.com 2019 - 2024. All rights reserved.