yard はクラス定義やメソッド定義箇所に、YARDの記法に従いコメントをつけることで、ドキュメントを生成することができるツールです。github.com 使い方 yard インストール $ gem install yard yard バージョン確認 $ yardoc --version ヘルプ $ yardoc --he…

wiki や redmine などを markdown に切り替えて編集する際に url のリンクの書き方がわからなかったためここにメモします。以下のように記載します。 [タイトル](URL)例として google のサイトで作成してみます。 [google](https://www.google.com/)作成した…

最近ドキュメントの作成にdiagrams.netを使用しているので使い方をここにメモします。 (使い方をすぐに忘れちゃうので...) diagrams.netとは 使い方 アクセス 起動 保存方法選択 テンプレート選択 作図 diagrams.netとは 「diagrams.net」は、システム構成図…

GitHub で Markdown を使った折りたたみ記法を用いたとき、中身の形成がうまくいかなかったので回避方法をここにメモします。 回避方法 整形されない記述 整形される記述 参考 回避方法 ＜/summary＞の後に空行だけの行を追加する。 整形されない記述 <details> <summary>整形</summary></details>…