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

adapter-functionにSassDocを添付します #49

Merged
merged 28 commits into from
Jan 21, 2025
Merged

adapter-functionにSassDocを添付します #49

merged 28 commits into from
Jan 21, 2025

Conversation

piyoppi
Copy link
Contributor

@piyoppi piyoppi commented Jan 20, 2025

これまで内部的に管理していたAdapterの各関数のドキュメントを、SassDocの形式でソースコード中にコメントとして記述します。
これにより、以下のことが期待できます。

  • エディタによるHinting表示の際にドキュメントが表示される
  • 非推奨の関数にはその旨エディタ上に注釈を表示できる
  • ソースコードとドキュメントが近い距離に存在することによるメンテナンス性の向上

内部的に管理していたAdapterのドキュメントを、書き拾てのスクリプトで機械的にSassDocに変換しています(多少手による修正も入れています)。
ドキュメントの書きっぷりについては、まだ不足している箇所もあるとは思いますが、継続的に良くしていければと思います。

@piyoppi piyoppi requested review from fumink7 and gyugyu January 20, 2025 10:25
Copy link
Collaborator

@fumink7 fumink7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

やったーありがとうございます!🙌

Copy link
Contributor

@outskirtsHinode outskirtsHinode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ありがとうございます!良さそうです!

@piyoppi piyoppi merged commit 1ea8bb5 into main Jan 21, 2025
2 checks passed
@piyoppi piyoppi deleted the attach-sassdoc branch January 21, 2025 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants