add-code-comments

Rustコードコメント作成ガイド

Rustのモジュール、公開API、業務ロジック、テストに対する中国語コメントとADR参照の規約を適用します。

AIスキル大辞典による日本語要約
品質評価97/100評価確度:暫定
人気度(GitHub Star) 0発掘スコア 100
01

このSkillでできること

  • ✓Rustのモジュールに責務や関連モジュールを説明するコメントを追加する
  • ✓公開関数・構造体・列挙型に文書コメントを作成する
  • ✓業務ルールやエラー処理の理由を説明するコメントを追加する
  • ✓アーキテクチャ上の決定を対応するADRへ関連付ける
02

使い方

01
STEP 1

対象をモジュール、公開インターフェース、業務ロジック、テスト関数に分類する

02
STEP 2

対象に応じてモジュールコメント、公開APIコメント、業務ルールコメントを適用する

03
STEP 3

アーキテクチャ上の重要な箇所にADR番号と決定内容への参照を記載する

04
STEP 4

公開項目、ADR参照、業務ルール、エラー処理、テスト説明をチェックする

03

Skillのインストール

このGitHubリポジトリにあるSkillを確認し、現在の環境に適した方法でインストールしてください。
インストール後、正常に利用できることを確認し、基本的な使い方も簡潔に説明してください。

Repository:
https://github.com/openeuler-mirror/trustruntime
手動でインストールする

README / SKILL.mdから機械抽出できたコマンドのみ表示しています。推測したコマンドではありません。

sudo mkdir -p /etc/cert/cms /etc/cert/server
sudo cp /tmp/test-certs/cms/node-a/signer.crt /etc/cert/cms/signer.crt
sudo cp /tmp/test-certs/cms/node-a/signer.key /etc/cert/cms/signer.key
sudo cp /tmp/test-certs/cms/node-a/ca_root.crt /etc/cert/cms/ca_root.crt
sudo cp /tmp/test-certs/tls/server/node-a/certificate.crt /etc/cert/server/certificate.crt
sudo cp /tmp/test-certs/tls/server/node-a/private.key /etc/cert/server/private.key
sudo cp /tmp/test-certs/tls/server/node-a/key_pwd.txt /etc/cert/server/key_pwd.txt
sudo cp /tmp/test-certs/tls/server/node-a/ca_root.crt /etc/cert/server/ca_root.crt
sudo chmod 600 /etc/cert/cms/signer.key
sudo chmod 600 /etc/cert/server/private.key
sudo chmod 600 /etc/cert/server/key_pwd.txt
sudo mkdir -p /etc/trustruntime
sudo chmod 750 /etc/trustruntime
sudo cp conf/agent.toml /etc/trustruntime/agent.toml
04

このSkillを使うプロンプト例

Skill名を明示すると、意図したSkillを使わせやすくなります。自動発動型では必須とは限りません。

Rustコードの公開APIと業務ロジックを確認し、プロジェクトの規約に従って中国語のコメントを追加してください。公開項目には文書コメントを付け、アーキテクチャ上の決定には対応するADRを参照し、業務ルールとエラー処理では理由を説明してください。
出力例を見る
```rust
/// 署名を検証し、検証結果を返します。
///
/// # Errors
/// 検証処理に失敗した場合にエラーを返します。
///
/// 架构决策:详见 ADR-0004
pub fn verify_signature(input: Input) -> Result<Outcome> {
    // 业务规则:根据验证结果映射统一结果码
    verify(input)
}
```
05

安全性チェック

自動解析による参考情報です。Skillの安全性を保証するものではありません。

外部API通信明確な記述なし
Shellコマンド実行検出あり
ファイル読み取り明確な記述なし
ファイル書き込み明確な記述なし
ネットワークアクセス明確な記述なし
認証情報明確な記述なし
検出根拠を見る
  • shell: # opencode配置 [large code block omitted] 查看服务日志: ```bash tail -f /tmp/trustruntime.log ``` 或查看默认日志文件: ```bash tail -f /var/log/trustruntime/trus
  • shell: ```bash tail -f /tmp/trustruntime.log ``` 或查看默认日志文件: ```bash tail -f /var/log/trustruntime/trustruntime.log ``` ### 6. 测试服务连接 #### 6.1 准备测试配置文件 创建文
06

関連Skill