mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-23 03:04:29 +08:00
bb449259d3
- 新增 .claude/skills 目录及完整的文档生成技能系统 - 添加批量 API 文档生成脚本支持模块化文档创建 - 添加 API 文档、功能指南和教程生成模板与示例 - 添加 C# XML 注释解析和代码示例生成工具 - 添加文档验证和导航更新脚本确保质量 - 更新 .gitignore 配置排除本地设置文件
49 lines
1.2 KiB
Bash
49 lines
1.2 KiB
Bash
#!/bin/bash
|
|
# 解析 C# XML 文档注释
|
|
# 用法: parse-csharp-xml.sh <C# 文件路径>
|
|
|
|
set -e
|
|
|
|
FILE_PATH="$1"
|
|
|
|
if [ -z "$FILE_PATH" ]; then
|
|
echo "用法: $0 <C# 文件路径>"
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -f "$FILE_PATH" ]; then
|
|
echo "错误: 文件不存在: $FILE_PATH"
|
|
exit 1
|
|
fi
|
|
|
|
echo "解析 C# XML 文档注释: $FILE_PATH"
|
|
|
|
# 提取 summary 标签内容
|
|
echo "=== Summary ==="
|
|
grep -A 5 "/// <summary>" "$FILE_PATH" | grep "///" | sed 's/.*\/\/\/\s*//' | sed 's/<summary>//g' | sed 's/<\/summary>//g' || echo "未找到 summary"
|
|
|
|
# 提取 param 标签内容
|
|
echo ""
|
|
echo "=== Parameters ==="
|
|
grep "/// <param" "$FILE_PATH" | sed 's/.*\/\/\/\s*//' || echo "未找到 param"
|
|
|
|
# 提取 returns 标签内容
|
|
echo ""
|
|
echo "=== Returns ==="
|
|
grep "/// <returns>" "$FILE_PATH" | sed 's/.*\/\/\/\s*//' | sed 's/<returns>//g' | sed 's/<\/returns>//g' || echo "未找到 returns"
|
|
|
|
# 提取 exception 标签内容
|
|
echo ""
|
|
echo "=== Exceptions ==="
|
|
grep "/// <exception" "$FILE_PATH" | sed 's/.*\/\/\/\s*//' || echo "未找到 exception"
|
|
|
|
# 提取 example 标签内容
|
|
echo ""
|
|
echo "=== Examples ==="
|
|
grep -A 10 "/// <example>" "$FILE_PATH" | grep "///" | sed 's/.*\/\/\/\s*//' || echo "未找到 example"
|
|
|
|
echo ""
|
|
echo "解析完成"
|
|
|
|
exit 0
|