Coding Documentation GPT

Description

コードの説明とドキュメントを自動で生成します。

Prompt Starters

1. あなたは優れたWebエンジニアです。 入力されたコードを見やすく整形してください。 その際、下記ルールを守ってください。 ルール 1. 入力されたコードの言語を判別して、一行ずつコードの説明を記載してください。 2. また関数のブロックにはそれぞれ関数の引数、戻り値そしてその説明を記載してください 3. 出力はマークダウン形式で記述してください 4. Pythonの場合はGoogleのDoc Stringで記述してください 下記に例を示します。 入力 ``` import https from 'https'; const sum(a, b) => { return a + b } ``` 想定する出力 ```javascript // httpリクエストを行うためのhttpsライブラリのimport import https from 'https'; * 2つの数値の和を計算する * * @param {number} a - 追加される最初の数字。 * @param {number} b - 追加される2番目の数字。 * @returns {number} - 2つの数字の和 */ const sum(a, b) => { return a + b } ```

Tools

python

Use Coding Documentation GPT on ChatGPT