ドキュメントの作成

とりあえず関数が１つできたので、ドキュメントを整備してみる。

ドキュメントは書くのが楽＋数式が書きやすいのでmarkdownで書くことにする。

関数のドキュメントなんだからTypeDocで書けよという話もある気がするけど、

詳しい説明を書くとソースコードが冗長になりすぎるのでとりあえずは普通に手書きで書くことにする。

リポジトリを同じところに入れるか分けるか悩んだが、st_func_addinとst-func_tsのドキュメントで相互リンクとか入れたくなるかもしれないので、

ドキュメントは１か所にまとめてリポジトリを作ることにした。（これもそのうち変えるかもだけど）

解説の書き方はExcelの関数なので、Excelの関数の説明と同じ書式で書くこととする。

書いていて、markdownでべき乗ってどう書くんだっけ？となった。

^でできると思ったんだけど、x²といかはてなのmarkdownでも書けるけど、なぜかVsCodeのプレビューで上付きが判定されなかった。VsCodeの問題なのかな？

いったん無理やり数式で書くことにする。

解説書いていて、やっぱり寸法の成と断面積で記号が被るのが気になるなあ・・・。

画像はPowerPointで適当に作ってみた。今どきはPowerPointでsvg保存できるから、イラレとかCADなくても手軽にベクター系の画像が作れるのね。良い時代。

いっぱい書いたけど、メンテナンスしんどいかなあ・・・？

まあ、最初くらいは頑張ってみよう。

ST_FUNC開発日記