文章目录
前言
最近要和别人交际,就要给API文档,但是感觉API文件手动写有点麻烦,想着怎么弄一个自动API文档生成
Sandcastle
折腾了两小时,好像不太好用
DocFX
既然不好用,那就换DocFX好了
不知道为啥我运行docfx init -q 就会报错
折腾了半天,终于折腾出来了,吗?
我感觉效果很差
{
"metadata": [
{
"src": [
{
//这个就是你的src文件路径
"src": "src",
//这个是你生成的解决方案的dll
"files": [
"ConsoleApp1.dll"
]
}
],
"dest": "api"
}
],
"build": {
"content": [
{
"files": [
"api/*.yml"
],
"exclude": [
"_site/**"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"template": [
"default",
"modern"
],
"globalMetadata": {
"_appName": "mysite",
"_appTitle": "mysite",
"_enableSearch": true,
"pdf": true
}
}
}