有没有更好的方法为这种情况提供xml文档?

时间:2018-07-16 21:50:21

标签: c# .net xml documentation xml-documentation

我具有以下类构造函数,并且添加了一些初始的xml文档:

        /// <summary>
        /// Constructor for initializing SecurityApiServiceWrapper
        /// </summary>
        /// <param name="apiBaseUrl">The base url to use for SecurityApi calls
        /// </param>
        /// <param name="apiVersion">The version of the SecurityApi to use</param>
        /// <example>
        /// apiBaseUrl of "https://security.mycorp.com" will call SecurityApi in prod
        /// apiVersion of "2" will direct subsequent API calls to /api/v2/...
        /// </example>
        public SecurityApiServiceWrapper(string apiBaseUrl, string apiVersion)
        {
            _apiBaseUrl = apiBaseUrl;
            _apiVersion = apiVersion;
        }

如果我将本节中的每一行并在主参数描述之后嵌套在相应标记内,似乎在语义上会更干净。但是,VS intellisense不会将嵌套结构作为选项。是否有比我上面提供的代码示例中配置的参数示例更好的方法?

0 个答案:

没有答案