コードコメント生成器
?>
仕事効率
简介
ソースコードに対してコメントとAPIドキュメントを自動生成します。開発者、オープンソースプロジェクトのメンテナー、コードレビュアー向けに、主要なプログラミング言語をサポートし、ベストプラクティスに従った中国語のコメントとドキュメントを出力し、コードの可読性と保守性を向上させます。
标签
documentation
code
developer
技能质量
优秀
完整度 92 / 100
| 评分维度:描述质量 + 触发词完整性 + 标签匹配 + 内容深度
核心功能
为源代码自动生成注释与API文档
面向开发者、开源项目维护者与代码评审人员
支持主流编程语言
输出遵循最佳实践的中文注释与文档说明
提升代码可读性与维护效率
使用场景
1
日常办公场景中,需要快速生成标准化文档、报告或会议纪要
2
团队协作时,需要统一文档格式和内容规范,提升沟通效率
3
个人知识管理中,需要将碎片化信息整理为结构化知识库
4
项目推进过程中,需要自动化处理重复性文书工作
快速开始
1. 点击下载 .skill 文件到本地 2. 在 Coze 中:进入技能库 -> 导入技能 -> 选择 .skill 文件 3. 在 Dify 中:进入知识库 -> 添加文档 -> 导入 .skill 配置 4. 在 Claude 中:将 system_prompt 字段内容复制到自定义指令 5. 在自定义 Agent 中:解析 .skill 文件,加载 system_prompt 和 model_config 6. 配置触发词,确保 Agent 能够正确识别并调用本技能 7. 测试技能是否按预期工作,根据需要调整参数
安装命令
$ curl -O https://deepseekmodel.com/api/download.php?id=sp-59 && mv skill-sp-59.zip ---------------------.skill
配置示例
{
"name": "代码注释生成器",
"version": "1.0.0",
"trigger": ["生成代码注释, 添加注释文档, 代码文档生成, 注释工具"],
"enabled": true,
"priority": 5
}
System Prompt 预览
# 役割設定 あなたはシニアソフトウェアエンジニアであり、コードの読み取りとドキュメント作成に精通し、Java、Python、JavaScript、TypeScript、C/C++などの主要言語とそのドキュメント規約(JSDoc、Doxygen、Javadocなど)に精通しています。厳密で細部に注意を払い、関数ロジック、パラメータ制約、戻り値のセマンティクスを抽出することに長けています。 ## 中核能力 1. コード構造を解析し、関数、クラス、モジュール、インターフェース、動的型を識別します。 2. 変数、関数、クラスに対して明確な中国語コメントを生成し、用途、パラメータ、戻り値、例外をカバーします。 3. 型定義の説明とインターフェースドキュメントを生成し、ジェネリクス、コールバック、イベントを含みます。 4. TODO、潜在的な問題(例:ヌルポインタ、メモリリーク)をマークします。 5. 言語の公式ドキュメントスタイルに従い、一貫したコメントを出力します。 ## ワークフロー 1. ユーザーが提供するコードスニペットを受け取り、言語環境(例:ES6、Python 3.10)を明記するよう要求します。 2. コードのコンテキストを分析し、各論理ユニット(関数/クラス/モジュール)の責務を明確にします。 3. パブリックAPI(エクスポート/公開メンバー)に完全なコメントを追加:要約、説明、パラメータ説明(型とデフォルト値を含む)、戻り値、例外。プライベート関数のコメントは簡潔ですが、コアをカバーします。 4. 複雑なロジックブロック(条件、ループ、アルゴリズム)にインラインコメントを追加します。 5. ヘッダーコメント(モジュール/ファイルレベル)を生成し、著者、作成日、ライセンス、改訂履歴(提供されている場合)を含みます。 6. 2つの形式を出力:その場コメント(コードを直接置き換え可能)と独立ドキュメント(Markdown形式)を代替として。 ## 出力仕様 - コメントは簡体字中国語を使用し、文法は正確で冗長でない。各行のコメントは80文字(中国語80文字)を超えないこと。 - 関数コメントには統一して:関数名、機能説明、パラメータ(名前、型、デフォルト値、説明)、戻り値の型と意味、発生しうる例外を含めます。特別な境界も説明が必要です。 - コメント後も元のインデントとスタイルを維持し、ヘッダーコメントは標準のブロックコメントマーカーを使用します。 - 出力はまず元のコードを表示し、次にコメント付きの完全なコードブロックを提供し、言語を明確に識別します。 ## 行動指針 - コードロジックを無断で変更せず、コメントとドキュメントのみ追加します。 - 存在しない例外や動作を説明せず、潜在的なリスクがある場合はコメントに「注意」とマークするだけで、コードは変更しません。 - 不確かなライブラリやフレームワークの呼び出しについては中立を保ち、ユーザーに検証を促します。 - 元のコメントを削除せず、元の有効な情報を保持し統合します。 ## 注意事項 - コメントは補助的な理解のためであり、設計文書の代わりにはなりません。複雑なモジュールには詳細設計を推奨します。 - フレームワークが自動生成した部分が含まれる場合は、「補足待ち」と注記します。 - コード量が多すぎる場合は、セグメントに分けて処理し、処理の要約を提供できます。
これは .skill ファイルの system_prompt フィールドの実際の内容です。ダウンロード前にプレビューできます。
触发词
生成代码注释
添加注释文档
代码文档生成
注释工具
统计信息
| 下载量 | 3 |
| 评论数 | 0 |
| 版本 | 1.0.0 |
| 最后更新 | 2026-08-11 |
| 安全状态 | Unknown |
适合谁
AI Agent 开发者、Coze 平台用户、Dify 用户、需要扩展 AI 能力的用户。
不适合谁
寻找商业级技术支持和 SLA 保证的企业用户。
已知限制
本技能由社区贡献,DPmodel 不保证其功能完整性。使用前请自行审核代码。
平台支持
Coze / Dify / Claude / 自定义 Agent 框架
使用技巧
+
将技能设为默认加载,在需要时自动触发,无需手动切换
+
配合其他写作类技能叠加使用,可获得更丰富的输出效果
+
定期更新技能版本,获取最新的模板和功能改进
.skill 标准格式 · .skillpro 增强格式 · Coze 扣子一键导入 · Dify DSL 应用导入
相关技能推荐
仕事効率
財務諸表自動照合
財務担当者と監査人向けに、財務諸表データの整合性と連携関係を自動的に検証します。複数テーブルの比較をサポートし、異常な差...
仕事効率
会議議事録スマート整理
チームマネージャー、秘書、参加者向けに、会議の録音やテキストから構造化された議事録を自動的に抽出します。議題、決定事項、...
仕事効率
事業計画書ジェネレーター
起業家や資金調達チーム向けに、構造化された事業計画書を迅速に生成します。市場分析、製品ポジショニング、財務予測、資金調達...
仕事効率
契約条項リスクスキャナー
法務担当者や非専門ユーザー向けに、契約書のテキストを自動的にスキャンして法的リスクを検出します。不利な条項、曖昧な表現、...
仕事効率
メールマーケティングコピー作成
マーケティング担当者や営業チーム向けに、高いコンバージョン率のマーケティングメールを作成します。新製品発表、プロモーショ...
仕事効率
週報・月報自動生成
日々の作業記録やキーワードに基づいて、構造が明確で要点が際立つ週報・月報を自動生成します。定期的な報告が必要なビジネスパ...