Zelig[冰冷的变色龙]-C/C++/Delphi/Golang小记[记录自己学习,记录Windows/Linux/Mac 学习小记]

[生成]Delphi - 单元帮助文档工具

Snipaste_2022-02-13_08-11-03.png


生成 Delphi 单元帮助文档用的

在你的单元文件内的函数前 加上下面的注释样本

(*>  
yaml
<*)

Delphi 的(* *) 加上 > < 记得贴近 哈
里面的内容就是 yaml 文本
group 组 如 它是一个类 就写上类名
title 显示的菜单列表的标题
parameter 参数 直接拿delphi的 ()那的参数 复制进去即可。|加上后的 家是参数个体说明
result 结果 如果没有 可以不写 会识别成过程
example 例子
describe 描述


全部是小写哦

下面给出完整的例子

(*>
group: test
title: 测试
name: Test
parameter: 'const Field: string|字段; const Value: Int64 = 0|值'
result: int
example: |-
  function test(const S:  string):Boolean;
  begin
  ..................
  end;
describe: 嘿嘿这是一个开始\n哈哈结束咯
<*)



/// 生成文档内容

Zelig.DocApi  -pf "d:\delphi\test.pas" // 如果都写在一个文件 可以这样
如果是多个单元文件

Zelig.DocApi  -pd "d:\delphi\test"

添加完成后
Zelig.DocApi -wo //启动


当然你也可以吧www这个文件夹复制出去 到nginx等静态处理服务。。

Zelig.ApiDoc
类型:压缩文件|已下载:19|下载方式:免费下载
立即下载

相关推荐

评论

  • 昵称 (必填)
  • 邮箱
  • 网址