Link Symbol Comment

在代码注释中创建可点击的链接，快速跳转到函数定义。

特性

• 📝 简单语法: 使用 [描述](https://github.com/meetrice/link-symbol-comment/blob/HEAD/文件@函数名) 或 [描述](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@函数名) 格式
• 🎯 快速跳转: Ctrl/Cmd + 点击链接即可跳转
• 🌐 多语言支持: Python, JavaScript, TypeScript, PHP, Java, C/C++, Go, Rust, Ruby, C#, Vue, HTML
• ✨ 简洁显示: 光标不在行上时，只显示描述文本
• 🔗 跨文件跳转: 支持跳转到其他文件的函数

语法

跳转到其他文件

# 参见 [greet 函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/utils.py@greet)
# 参见 [DataProcessor 类](https://github.com/meetrice/link-symbol-comment/blob/HEAD/utils.py@DataProcessor)

跳转到当前文件

# 参见 [main 函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@main)
# 参见 [greet 函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@greet)

使用示例

Python 示例

"""
## 模块结构

├── [greet 问好函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@greet)
├── [calculate_sum 求和函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@calculate_sum)
├── [DataProcessor 数据处理类](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@DataProcessor)
└── [main 主函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@main)
"""

def greet(name):
    """向用户问好"""
    return f"Hello, {name}!"

def main():
    processor = DataProcessor()
    result = processor.process("test")

JavaScript 示例

// 参见 [helper 函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/utils.js@helper)
// 参见 [main 函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@main)

function main() {
    // 主函数
}

Vue 示例

<script setup>
// 参见 [fetchData 数据获取](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@fetchData)
// 参见 [handleSubmit 提交处理](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@handleSubmit)

const fetchData = async () => {
  // ...
}
</script>

HTML 示例

<!-- 参见 [提交按钮](https://github.com/meetrice/link-symbol-comment/blob/HEAD/index.html@submit-btn) -->
<button id="submit-btn">提交</button>

<script>
// 参见 [验证函数](https://github.com/meetrice/link-symbol-comment/blob/HEAD/@validateForm)
function validateForm() {
  // ...
}
</script>

安装

在 VSCode 扩展市场搜索 "Link Symbol Comment" 并安装。

使用方法

1. 在注释中使用链接语法
2. 链接会显示为蓝色下划线
3. 按住 Ctrl (Windows/Linux) 或 Cmd (Mac) 并点击链接
4. 或者右键选择 "Go to Definition"

支持的语言

配置

无需额外配置，安装后即可使用。

许可证

MIT

反馈

如有问题或建议，请在 GitHub 提交 Issue。