在powershell脚本中嵌入doxygen文档

时间:2017-08-31 11:22:18

标签: powershell doxygen

我想制作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/FORTecH/Tools/Scripts/MakeDelivery/MakeDelivery.psm1 ...
  建立小组名单......

PowerShell文件显示在生成的HTML文档的文件列表中,但根本没有文本。有什么必要使用doxygen来创建PowerShell外部可读的文档? 应尽可能使用可用的文档。

0 个答案:

没有答案