AutoDoc ChatGPT

autodoc-chatgpt

AutoDoc-Chatgptは、ChatGPTモデルの力を活用して、プログラミング言語のドキュメントを自動的に生成するPythonスクリプトです。

autoDoc-chatgptを使用すると、コードベースの包括的なドキュメントを簡単に生成できます。文書化するファイルへのパスを提供するだけで、AutoDoc-Chatgptは、自然言語の機能、パラメーター、および戻り値の詳細な説明を生成します。

はじめる

インストール

このリポジトリをローカルマシンにクローンします。

git clone https://github.com/awekrx/AutoDoc-ChatGPT.git

次に、必要なパッケージをインストールします。

pip install -r requirements.txt

サポートされているプログラミング言語

• Python
• JavaScript
• タイプスクリプト
• 行く
• C＃
• C ++
• Php
• ルビー
• さび
• Java
• コトリン

そして他の...

disclaimer ：TypeScriptとJavscriptにはいくつかのバグがあり、テスト中です

disclaimer_2.0 ：同じ名前のメソッドを持つ2つ以上のクラスを持つファイルをコメントする既知のエラーコメントがあります。

使用法

構成を編集します

config.iniを開き、OAuth認証を使用していない場合はそこにemailとpasswordを追加します。それ以外の場合は、chatgptを開き、 __Secure-next-auth.session-token cookieを取得し、 session-tokenに書き込みます。

始める

py main.py -file " path to the file "

ファイルへのパスは、相対的または絶対的なものです。

実行後、ファイルyourfilename_commented.languageは、目的のファイルを使用してフォルダーに作成されます。

または

py main.py -file " path to the file "

お勧めしません、テストはほとんどありません。このようなコメントを作成するコメントオプションを備えたファイルを指定できます。

使用例

代替使用

これをPythonの関数として使用することもできます。

 from modules . autodoc import AutoDoc
import configparser

config = configparser . ConfigParser ()
config . read ( "config.ini" )

auth = {
    "email" : config [ "ChatGPT" ][ "email" ],
    "password" : config [ "ChatGPT" ][ "password" ],
    "session_token" : config [ "ChatGPT" ][ "session_token" ]
}

result = AutoDoc (
        auth ,
        "Code for commenting" ,
        "language code" ,
        "example comment model (optional)"
    ). start ()
print ( result )
# out: Code with comments 

免責事項

常に正しいコメントを作成するわけではありません。それは常にあなたが望むものを意味するとは限りません。編集する必要がある可能性のあるコメントのドラフトとして使用してください。

ライセンス

このプロジェクトは、MITライセンスの下でライセンスされています。

謝辞

AIの開発に感謝し、READMEを生成するためのсhatgptに個別に感謝します。

また、chatgptを作成するためのacheong08。