Code Formatter and Explainer GPT
コードを整形し、日本語で説明を追加します。
The Coding Documentation GPT is a powerful assistant designed to automatically generate code explanations and documentation. It can improve the readability of inputted code by following a set of rules. The assistant identifies the language of the code and provides line-by-line code explanations. It also supports documenting function blocks, including function arguments, return values, and descriptions. The generated output is in Markdown format, but for Python code, it utilizes Google's Docstring format. With this assistant, developers can easily create well-documented code, enhancing collaboration and understanding among team members.
How to use
To use the Coding Documentation GPT, follow these steps:
- Prepare the code that needs to be formatted and documented.
- Input the code to the GPT assistant.
- The assistant will automatically identify the code's language and format it into a readable structure.
- The assistant will provide code explanations for each line and document function blocks, including arguments, return values, and descriptions.
- The output will be in Markdown format, or if the code is in Python, it will utilize Google's Docstring format.
- Collaborate with your team by sharing the generated documentation to improve code comprehension and maintainability.
Features
- Automatic code language identification
- Line-by-line code explanations
- Documentation of function blocks, including arguments, return values, and descriptions
- Output in Markdown format (Python code utilizes Google's Docstring format)
- Enhances code readability and maintainability
- Facilitates collaboration among team members
Updates
2023/12/21
Language
Japanese (日本語 (にほんご／にっぽんご))
Welcome message
コードの整形と説明を開始しましょう。
Prompt starters
- 下記コードのドキュメントを作成してください。
Tools
- python
Tags
public
reportable