.NET API Документация с DocFX - Как правильно отобразить вызов метода в примере кода - PullRequest
Новая
       6

.NET API Документация с DocFX - Как правильно отобразить вызов метода в примере кода

0 голосов
/ 31 января 2019

Я пытаюсь использовать функцию нотации XML в Visual Studio для создания документации для API, который я пишу.Я столкнулся с проблемой, когда я не могу понять, как ссылаться на имя метода в моем примере кода без автоматического заполнения типов параметров

Пример: 

    /// <summary>
    /// Exports the certificate corresponding to the specified certificate thumbprint to a Base64-encoded text file
    /// </summary>
    /// <param name="certThumbprint">Certificate thumbprint (case-insensitive)</param>
    /// <param name="exportPath">Fully-qualified path to where the Base64-encoded file should be written (a ".cer" file extension will be added if no file extension is detected)</param>
    /// <param name="certStore">(Optional) The certificate store where the encryption certificate resides (Default: <see cref="CertStore"/>.<see cref="CertStore.CurrentUser"/>)</param>
    /// <param name="verbose">True enables verbose logging</param>
    /// <returns>The fully-qualified path to where the Base64-encoded certificate file was ultimately written</returns>
    /// <example>
    /// <code>
    /// string thumbprint = @"ccdc673c40ebb2a433300c0c8a2ba6f443da5688";
    /// string exportPath = @"C:\data\cert";
    /// <see cref="CertStore"/> certStore = <see cref="CertStore"/>.<see cref="CertStore.CurrentUser"/>;
    /// string finalExportPath = <see cref="X509Utils"/>.ExportCert(thumbprint, exportPath, certStore);
    /// //finalExportPath is @"C:\data\cert.cer"
    /// </code>
    /// </example>

Это приводит кследующие результаты с использованием DocX:

Rendered documentation

Почему я не могу ссылаться на имя метода без автоматического отображения типов параметров?Нужно ли использовать строковый литерал для вызова метода в примере, а не ссылаться на него?

1 Ответ

0 голосов
/ 31 января 2019

Содержимое было взято из кэшированной версии документации API.Полное удаление и повторное создание проекта DocFX решило проблему.Документация XML в моем примере выше отображается правильно.

...