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

DresscaのJavadocコメントの文体を統一する #1719

Open
kenjiyoshid-a opened this issue Dec 18, 2024 · 0 comments
Open

DresscaのJavadocコメントの文体を統一する #1719

kenjiyoshid-a opened this issue Dec 18, 2024 · 0 comments
Assignees
Labels
target: Dressca サンプルアプリケーションDresscaに関係がある 内部の改善 機能更新やドキュメント更新ではない改善
Milestone

Comments

@kenjiyoshid-a
Copy link
Contributor

概要

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

  • 原則呼び出す側の視点で書いてあること。
  • 敬体(です、ます)であること。
  • 引数や戻り値の説明に関しては、体言止め(常体)でも問題ない。
    あわせて、全角文字と半角文字の間にスペースが入っていない箇所にはスペースを入れる。

textlintのルール(ja-spacing/ja-space-between-half-and-full-width)に該当する。

完了条件

  • XMLコメントの文体が原則に従った形になっていること
@kenjiyoshid-a kenjiyoshid-a added not triaged 精緻化、分析がされていない target: Dressca サンプルアプリケーションDresscaに関係がある 内部の改善 機能更新やドキュメント更新ではない改善 and removed not triaged 精緻化、分析がされていない labels Dec 18, 2024
@kenjiyoshid-a kenjiyoshid-a added this to the v1.0.0 milestone Dec 18, 2024
@kenjiyoshid-a kenjiyoshid-a self-assigned this Dec 18, 2024
@kenjiyoshid-a kenjiyoshid-a changed the title Javadocコメントの文体を統一する DresscaのJavadocコメントの文体を統一する Dec 18, 2024
@tsuna-can-se tsuna-can-se modified the milestones: v1.0.0, v1.1.0 Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target: Dressca サンプルアプリケーションDresscaに関係がある 内部の改善 機能更新やドキュメント更新ではない改善
Projects
None yet
Development

No branches or pull requests

2 participants