本日はAWESOME-COPILOTの技術調査枠です。
AWESOME-COPILOTのドキュメントを読みながら実際に操作を試して記事に残します。
今回は再利用可能なプロンプトの一つC# Documentation Best Practicesを試してみます。
C# Documentation Best Practices
C# Documentation Best PracticesはC#型がXMLコメントで文書化されていることを確認し、ドキュメント化のベストプラクティスに従います。
以下のページからC# Documentation Best Practicesのインストールボタンをクリックして取得します。
github.com
インストールボタンを押してC# Documentation Best Practicesをダウンロードします。
するとチャットモードのスラッシュコマンドで /csharp-docs が利用できるようになります。
本プロンプトを選択して、指定のファイルにコメントを追加することができます。
以下のようにシャープ変数を利用してプロンプトに対象のファイルの参照を引き渡します。
/csharp-docs #(対象ファイル)
処理が完了すると、対象のファイルのパブリックな関数にXMLコメントが追加されます。
もしコメントを日本語で出力してほしい場合はプロンプトファイルに、日本語で会話とコードコメントを出力する旨を追記します。
以下の通りプロンプト文の概要部分に一文を変更しました。
Please conduct conversations and code comments in Japanese.
この状態で改めてプロンプトを送信します。
以下の通り、日本語でコメントが出力されました。
