obsidian社区插件
Obsidian 插件:Source Code Note
插件ID:source-code-note_readme
source-code-note_readme
source code-note_readme:帮助您轻松组织源代码注释。
Obsidian 插件:Source Code Note
插件名片
概述
帮助您轻松组织源代码注释。
原文出处
下面自述文件的来源于 Readme
Readme(翻译)
下面是 source-code-note 插件的自述翻译
Obsidian 源代码笔记插件
技术支持 AntV X6
功能
- 解析 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 左侧的按钮打开画布
反馈交流
其他渠道
版权声明
版权声明:所有 PKMer 文章如果需要转载,请附上原文出处链接。