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

XMLコメントの文体を統一する #2019

Closed
KentaHizume opened this issue Nov 14, 2024 · 0 comments · Fixed by #2239 or #2249
Closed

XMLコメントの文体を統一する #2019

KentaHizume opened this issue Nov 14, 2024 · 0 comments · Fixed by #2239 or #2249
Assignees
Labels
target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプルに関係がある target: ConsoleAppWithDI コンソールアプリケーションの要件別サンプルに関係がある target: Dressca サンプルアプリケーションDresscaに関係がある 内部の改善 機能更新やドキュメント更新ではない改善
Milestone

Comments

@KentaHizume
Copy link
Contributor

KentaHizume commented Nov 14, 2024

概要

一部のXMLコメントが原則に従わない文体になっているため、
下記の原則に従って、XMLコメントの文体を統一する。

  • 原則呼び出す側の視点で書いてあること。
  • 敬体(です、ます)であること。
  • 引数や戻り値の説明に関しては、体言止め(常体)でも問題ない。

あわせて、全角文字と半角文字の間にスペースが入っていない箇所にはスペースを入れる。
textlintのルール(ja-spacing/ja-space-between-half-and-full-width)に該当する。

完了条件

  • XMLコメントの文体が原則に従った形になっていること
@KentaHizume KentaHizume added the 内部の改善 機能更新やドキュメント更新ではない改善 label Nov 14, 2024
@KentaHizume KentaHizume added this to the v1.0.0 milestone Nov 14, 2024
@tsuna-can-se tsuna-can-se modified the milestones: v1.0.0, v1.1.0 Dec 10, 2024
@tsuna-can-se tsuna-can-se added target: Dressca サンプルアプリケーションDresscaに関係がある target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプルに関係がある labels Jan 6, 2025
@tsuna-can-se tsuna-can-se modified the milestones: v1.1.0, v1.0.0 Jan 7, 2025
@fkoyama fkoyama added the target: ConsoleAppWithDI コンソールアプリケーションの要件別サンプルに関係がある label Jan 7, 2025
@fkoyama fkoyama linked a pull request Jan 7, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target: Azure AD B2C Auth Azure AD B2C認証の要件別サンプルに関係がある target: ConsoleAppWithDI コンソールアプリケーションの要件別サンプルに関係がある target: Dressca サンプルアプリケーションDresscaに関係がある 内部の改善 機能更新やドキュメント更新ではない改善
Projects
None yet
3 participants