Obsidian 插件:Source Code Note

Obsidian 插件:Source Code Note

插件名片

  • 插件名称:Source Code Note
  • 插件作者:Waiting
  • 插件说明:帮助您轻松组织源代码注释。
  • 插件分类:[‘obsidian 插件 ’, ‘readme’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装

概述

帮助您轻松组织源代码注释。

Obsidian 插件:Source Code Note--概述

原文出处

下面自述文件的来源于 Readme


Readme(翻译)

下面是 source-code-note 插件的自述翻译

Obsidian 源代码笔记插件

Chinese Documentation

技术支持 AntV X6

功能

  • 解析 Obsidian 笔记中的代码块,绘制方法调用链接的图形,并将代码块保留在画布上以便于查看 Obsidian 源代码笔记插件--功能

如何使用

1. 在 Markdown 的代码块的代码注释部分,使用关键字写入相关信息

支持的关键字效果
@class对应方法的类名
@function方法名
@call调用相关方法,支持多个方法。格式:类名 @ 方法名

示例

/** 
 * 注册元数据字符串。
 * 
 * @class ShenyuClientHttpRegistryController
 * @function registerMetadata(@RequestBody final MetaDataRegisterDTO metaDataRegisterDTO)
 * @call RegisterClientServerDisruptorPublisher @ publish(final DataTypeParent data)
 * 
 * @param metaDataRegisterDTO 元数据注册DTO  
 * @return 字符串  
 */
@PostMapping("/register-metadata")  
@ResponseBody  
public String registerMetadata(@RequestBody final MetaDataRegisterDTO metaDataRegisterDTO) {  
    // 通过 Publisher 注册 元数据对象  
    publisher.publish(metaDataRegisterDTO);  
    return ShenyuResultMessage.SUCCESS;  
}
/** 
 * 注册元数据字符串。 
 * 
 * @class RegisterClientServerDisruptorPublisher
 * @function publish(final DataTypeParent data)
 * 
 * @param metaDataRegisterDTO 元数据注册DTO  
 * @return 字符串  
 */
@Override  
public void publish(final DataTypeParent data) {  
    // 获取 DisruptorProvider 
    DisruptorProvider<Collection<DataTypeParent>> provider = providerManage.getProvider();  
    // 调用 DisruptorProvider 的 onData 方法,发送数据  
    provider.onData(Collections.singleton(data));  
}

2. 点击 Obsidian 左侧的按钮打开画布



反馈交流

其他渠道

版权声明