.NET Conf 関西 2018−10-06での発表。 .NETにおけるドキュメンテーションツール、DocFXの紹介。

1. 1
DocFXでDocFXで
脱Excel方眼紙！脱Excel方眼紙！in .NET Conf 関西2018 2018-10-06
Иосиф Такакура (Iosif Takakura) @huideyeren
1

2. 2
はじめにはじめに
1

3. 3
自己紹介自己紹介
東京都在住
今日は東京から来ました
雑食系ITエンジニア
普段使う技術
.NET
JavaScript/TypeScript
Python
Ruby
今作っているモノ
なお、どれも「C#一本」にはならないかも……
議論できるメモ帳アプリ「Charanke」
いいことを3つ書き留めるプチ日記「e-koto-3」
1

4. 4
さて、ここからが本題。さて、ここからが本題。
1

5. 5
ドキュメント、書いてますか？ドキュメント、書いてますか？
ドキュメントを書くことは重要
でも、Excel方眼紙は勘弁
私は、Excel方眼紙が嫌い
私は、二重の手間が嫌い
だから、手作業で、Excelで書きたくないです。
1

6. 6
ドキュメントを自動で書きたいドキュメントを自動で書きたい
例えば、こんなツールがある
Java : JavaDoc
JavaScript : JSDoc
TypeScript : TypeDoc
Python : Sphinx
Ruby : RDoc, YARD
.NETにはあるのかな？
1

7. 7
ありました！ありました！
DocFX
1

8. 8
どうやって使うの？どうやって使うの？
1. ソリューションに「クラスライブラリー」プロジェクトを作りま
す。
2. NuGetで、 パッケージを追加します。
3. を編集します。
4. ビルドすると フォルダ内にドキュメントが出来上がります。
今は使ってはないけど、
です。
Swagger/OpenAPIのドキュメントも作れるら
しい
1

9. 9
どんなドキュメントが出来上がるの？どんなドキュメントが出来上がるの？
1

10. 10
使ってて残念なところ使ってて残念なところ
.NETアーキテクチャー以外のものに使える？
PDF出力がないところ
拡張機能が少ないところ
Markdownの方言問題
明確にはGFMじゃない
一応GFMに設定できる
1

11. 11
これからの展望これからの展望
非.NETアーキテクチャーも混在するシステムのドキュメント
とりわけ他の言語のツールとの協調関係
使い勝手の悪さをどう補うか
1

12. 12
ということで、次回予告。ということで、次回予告。
「C#とPythonとJavaScriptのドキュメントを一つにまとめる」
やります。
ただし発表はおそらく東京のどこかでやるんじゃないかと。
1

13. 13
ご清聴ありがとうございましたご清聴ありがとうございました
1