hobber-api-for-vscode

for a better project structure inspecting, try using comments as code anchors, provide navigating and structure virtualize. （inspired by todo tree view)

features

with this kind of commits will be list in sidebar explorer panel

/**
 * MYFlow: 流程名称
 * node: 节点名称
 * prevNode: 前一节点名称
 * desc: 节点描述：一个辉煌的开端
 */

• provide key and value complete support
• provide node definition an reference
• provide tree view interactive
• provide dag view (power by mermaid)

——————————————————————

传统的项目文档存在一些问题，例如文档关联到实际代码较为复杂，文档对熟悉代码的现有开发人员价值较低，等。

为了有更实用性的项目文档，尝试利用注释作为代码锚点，在锚点的数据之上，提供快捷代码浏览，代码结构概览等功能，以支持日常的项目开发。

特性

在代码中插入如下结构的注释，将被视作一个锚点，展示在侧边栏的explorer的一栏中

/**
 * MYFlow: 流程名称
 * node: 节点名称
 * prevNode: 前一节点名称
 * desc: 节点描述：一个辉煌的开端
 */

对于此种注释代码

• 提供key和value的自动完成
• 提供节点的定义及引用查询

对于树形图

• 点击流程的节点将跳转到节点的对应代码处。
• 点击流程的根将展示此流程的dag图。

使用案例

• 一个项目的基本结构，例如入口文件，配置文件，关键中间件等
• 一个项目的关键组件的结构，如配置生成及构建，请求参数的验证及构建，请求响应的使用等
• 一个复杂页面的模块层次划分