シェルスクリプトから仕様書を作るツール

自分用のメモ。

結構探したけど、なかなかこれってのがない。

• 極力書かなくて良い
• markdownにできる
• ぱっと動く

くらいしか思いはなかったんだが、結構ない。

で見つけたのが、これ。

#!/bin/bash
#
# @file Title of file script
# @brief Small description of the script.

アノテーションスタイルなら簡単だな、と。

# @description Multiline description goes here and
# there
#
# @example
#   some:other:func a b c
#   echo 123
#
# @arg $1 string Some arg.
# @arg $@ any Rest of arguments.
#
# @noargs
#
# @exitcode 0  If successfull.
# @exitcode >0 On failure
# @exitcode 5  On some error.
#
# @stdout Path to something.
#
# @see some:other:func()
some:first:func() {

これでビルド時にドキュメント化させようかな