c#中DocFx生成API帮助文档

  • 安装docfx
dotnet tool update -g docfx
  • 加载环境变量
export PATH="$PATH:/Users/xx/.dotnet/tools"
  • 初始化文档目录
docfx init
  • 修改配置docfx.json,src指向源码目录
"metadata": [
    {
      "src": [
        {
          "src": "../xx/",
          "files": [
            "**/*.csproj"
          ]
        }
      ],
      "dest": "api"
    }
  ],
  • 生成文档同时开启服务器
docfx docfx.json --serve   
  • 访问
    http://localhost:8080/

  • 仅生成文档

docfx docfx.json

相关推荐

  1. c#DocFx生成API帮助文档

    2024-04-06 05:32:05       37 阅读
  2. C# 使用DocX生成word文档

    2024-04-06 05:32:05       45 阅读
  3. C# 文件帮助类(FileHelper)

    2024-04-06 05:32:05       54 阅读
  4. vue 使用docx生成word表格文档

    2024-04-06 05:32:05       38 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-04-06 05:32:05       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-04-06 05:32:05       100 阅读
  3. 在Django里面运行非项目文件

    2024-04-06 05:32:05       82 阅读
  4. Python语言-面向对象

    2024-04-06 05:32:05       91 阅读

热门阅读

  1. 点云滤波与匹配进阶

    2024-04-06 05:32:05       37 阅读
  2. 添加背景图片画图matlab

    2024-04-06 05:32:05       34 阅读
  3. 【QT教程】QT6单元测试

    2024-04-06 05:32:05       32 阅读
  4. SPI协议

    SPI协议

    2024-04-06 05:32:05      34 阅读
  5. ubuntu23.10全家桶(date2024.4.3)

    2024-04-06 05:32:05       45 阅读
  6. nginx: 集群环境配置搭建

    2024-04-06 05:32:05       30 阅读
  7. Rust个人学习之单元测试

    2024-04-06 05:32:05       36 阅读
  8. 【PyQt】读取MySQL数据填充到Qt表格控件中

    2024-04-06 05:32:05       34 阅读
  9. 详解Qt中访问数据库

    2024-04-06 05:32:05       35 阅读
  10. 设计模式:享元模式

    2024-04-06 05:32:05       39 阅读
  11. 蓝桥杯入门题知识点总结

    2024-04-06 05:32:05       37 阅读
  12. 代码随想录第十六天: 二叉树part03

    2024-04-06 05:32:05       38 阅读