h2md - 头文件转Markdown文件
h2md 是一个简单工具用于将头文件转换为 markdown 文件。
h2md 没有任何依赖,是一个非常简单的行解析器。行头尾的空白字符将会被忽略。
以 //@
开头的行,是 h2md 指令,也是 markdown 文件的开始。
markdown 块每行以 //
开头,以空行或者源码结束。
markdown 块后紧跟的第一行源码必须是函数或者函数声明,并以(在同一行或下一行) {
或 ;
结束。
代码块以 //{
开头,并以 //}
结束,期间不能穿插非代码行。
新建一个文件,需要使用文件指令,如://@doc(docs/my-markdown.md)
。
从一个文件指令开始,产生的所有 markdown 都会写入这个文件,直到新的文件指令出现为止。