Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

削除したコメントに代わるdocstringの導入および引数・戻り値への型ヒントの追加 #4

Open
yuno-akey opened this issue Dec 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@yuno-akey
Copy link
Owner

Googleスタイルでのdocstringの導入。
引数・戻り値には型ヒントを(適切な形を検討して)付け、入出力の可読性を改善する。
複雑な処理を行っている関数についてはメンテナンス性を改善する為にコメントを付ける。誰から見ても関数名から処理が自明な場合は要検討。コメントの形式や説明についてもスタイルを統一する必要があるので、コメント導入は当issueに取り組む際、最後に熟慮して行う必要がある。
今後の機能拡張についてはこれらをコーディング規則として適用する。

@yuno-akey yuno-akey added the documentation Improvements or additions to documentation label Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant