DocFXでのAPIドキュメント作成について

s.kumagai 0 評価のポイント
2024-08-23T02:32:30.17+00:00

環境

Microsoft Visual Studio Community 2022 (64 ビット)

C# コンソールアプリ (.Net Core)

APIドキュメント作成のためNuGetパッケージ管理からdocfx.consoleをインストールしました。

docfx.json

"metadata": [
    {
      "src": [
        {
          "files": [
            "**.csproj"
          ],
          "src": "E:\\temp\\SolutionName"
        }
      ],
      "dest": "api",
      "disableGitFeatures": false,
      "disableDefaultFilter": false
    }
  ],
  "build": {
    "content": [
      {
        "files": [
          "api/**.yml",
          "api/index.md"
        ]
      },
      {
        "files": [
          "articles/**.md",
          "articles/**/toc.yml",
          "toc.yml",
          "*.md"
        ]
      }
    ]


システムの環境変数に下記の項目を追加しました。

変数名:MSBuildSDKsPath

値:C:\Program Files\dotnet\sdk\8.0.400\Sdks

リビルドは成功しますが、下記のような警告が出力され、結果としてAPIドキュメントはapiディレクトリに生成されず何も表示されません。

1>Build succeeded with warning.

1>[24-08-23 02:10:46.172]Warning:[MetadataCommand.ExtractMetadata]No metadata is generated for SolutionName.

1> 1 Warning(s)

1> 0 Error(s)

確認すべき項目が分かりません。

User's image

.NET
.NET
.NET ソフトウェア フレームワークに基づく Microsoft テクノロジ。
66 件の質問
Visual Studio
Visual Studio
Windows、Web、モバイル デバイス用のアプリケーションを構築するための統合開発ツールの Microsoft スイートのファミリ。
88 件の質問
0 件のコメント コメントはありません
{count} 件の投票

お客様の回答

回答は、質問作成者が [承諾された回答] としてマークできます。これは、ユーザーが回答が作成者の問題を解決したことを知るのに役立ちます。