Skip to content
This repository has been archived by the owner on Apr 12, 2023. It is now read-only.

型、関数、変数等に説明を付記する #56

Open
Takym opened this issue Mar 14, 2021 · 0 comments
Open

型、関数、変数等に説明を付記する #56

Takym opened this issue Mar 14, 2021 · 0 comments
Labels
confirmed 開発内部管理用 documentation 機能の改善や修正ではなく、ドキュメント類に関連するIssue

Comments

@Takym
Copy link
Contributor

Takym commented Mar 14, 2021

その機能リクエストは何らかの問題に関連しますか / Is your feature request related to a problem?

ソースコードを閲覧している時に、型や関数の役割・動作が分かりにくい時があります。
また、詳細な仕様もソースコードから推測する必要があります。

解決策についてお書きください / Describe the solution you'd like

プロジェクトファイルに <GenerateDocumentationFile>true</GenerateDocumentationFile> を追加した上で、型、関数、変数等に文書コメントを付記し、役割・動作を明確に分かる様にします。
コメントを付記する範囲は C# コンパイラからの警告が発生するもののみでも構わないと思います。

あなたが考える代替案についてご説明ください / Describe alternatives you've considered

今の所はありません。

その他 / Additional context


Internal IDs:

  • NFR 2947
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
confirmed 開発内部管理用 documentation 機能の改善や修正ではなく、ドキュメント類に関連するIssue
Projects
None yet
Development

No branches or pull requests

3 participants