CHM助手 >> 高效制作接口文档

 

 

1 CHM助手 >> 高效制作接口文档

1.1 概述

  用户如果书写代码的过程中使用了良好的注释，比如：doxygen规范， 则有可能生成比较规范的接口文档。很多工具软件都支持编程扩展，比如：宏/脚本接口，那么，完善的接口文档将会给用户带来极大的便利，否则，软件的使用和推广都会受到较大的影响。
  为了能够生成规范的接口文档，用户需要给函数添加规范的注释头，如下是一个规范示例：

// ---------------------------------------------------------------------------
// @fn         给命令绑定快捷键
// @param[in]  string strCommand: 命令名称,可以从"快捷键"设置窗口中获取命令列表
// @param[in]  string strKey: 快捷键,比如:CS+A表示Ctrl+Shift+A
// @param[in]  bool bSaveNow: true/false是否立即保存快捷键设置到key.ini配置文件
// @return     bool, 绑定是否成功true/false
// @author     tyysoft
// @date       2024-11-01 10:21:58
// @since      EverEdit 4.5.0(4500)
// @note       
// @code       js
// var ret = BindShortcut("cm_delete_word", "CSA+W", true); //给删除单词命令添加快捷键Ctrl+Shift+Alt+W
// @encode     
// ---------------------------------------------------------------------------
bool BindShortcut(string strCommand, string strKey, bool bSaveNow);

注：注释规范可以参考互联网上doxygen相关文档来书写，更简易的方法是使用插件EverEdit扩展-注释头添加注释。使用说明

1.2 使用方法

  1. 步骤1：使用EverEdit打开包含API说明的文档

  2. 步骤2：选择主菜单“扩展 -> 模式 -> CHM”，此时，主菜单中会增加“CHM助手”。

  3. 步骤3：选择菜单“CHM助手 -> 【文档】生成函数接口文档(M)”，如下图所示：

  4. 步骤4：接口文档生成后会自动打开目录，如下图所示

    注：Method是方法相关文档目录，Properties是属性相关文档目录。

  5. 步骤5：将生成的Markdown文档导入到笔记软件
    具体作法：将以上文档拷贝到VNote笔记目录，并在VNote目录树上选择右键菜单“重新加载”和“导入到索引”

  6. 步骤6：使用VNote打开接口文档相关页面，如下图所示：
    下图是本文开头范例生成为Markdown格式接口文档的效果：

1.3 约束

  CHM助手中只支持导出函数接口文档，不识别类信息。

文档作者声明：本文档仅用于学习交流，未经作者许可，不得将本文档用于其他目的。
Copyright © 2022~2024 All rights reserved.

posted @ 2024-12-21 22:09  tyysoft  阅读(5)  评论(0)  编辑  收藏  举报