Mobile勉強会 Wantedly × チームラボ #4 に参加しました。
Jetpack Compose、Flutter、KMM、Swift PMといろいろな話題が出てきて面白かったです。 普段はiOSアプリ開発ばかりで、AndroidやFlutterやKMMに触れる機会が少なくなりがちですが、興味はあるので実際に話を聞くと楽しいですね。 （分からないことも多いけど・・・）
僕はSwift-DocCとDokkaの話をしました。SwiftとKotlinのドキュメント生成ツールの話です。
ドキュメント生成ツールが主に活躍するのはライブラリ開発のときという印象もありますが、アプリ開発でも有益なんじゃないか、という視点で話をしました。
実は、Swift-DocCもDokkaも、単にドキュメントコメントからドキュメント生成するだけではなくて、独立したMarkdownファイルをドキュメントに含めることができるのです。 だから、アプリの設計ドキュメントを書くツールとしても使えるんじゃないかと思っています。
ところで今回調べていたとき、SwiftもKotlinも言語のガイドラインでドキュメントコメントをシンプルにせよと言っている点も興味深いなと思いました。 その点も、ツールの紹介の際に触れてみました。
SwiftもKotlinもガイドラインとしてドキュメントコメントをシンプルにせよというのがあるのは、ドキュメントコメントがシンプルにならないのはそも設計に問題がある可能性があるという考えがベースにあったり・・・するか？ #mobile勉強会
— くろるり (@kuroruri) 2022年2月22日
まさにそうですね！ Swiftのガイドラインには、サマリーが簡単に書けない場合は設計に問題があるかもしれないよ、と書いてあります。 #mobile勉強会
— 宇佐見 公輔 (@usamik26) 2022年2月22日
宣伝
なお、Swift-DocCについては技術同人誌を書いているので良かったらどうぞ。
usami-k.github.io
