C # CS1591 Missing XML Comment problem resolution for public visible types or members

Source: Internet
Author: User

Recently in the writing Web API project, use the Microsoft Web API help page component for automatic generation of API documentation, see Blog: https://www.cnblogs.com/lenmom/p/9081363.html, the effect is good, but the problem comes. , open the code today and see a lot of warnings

CS1591 missing XML comment for public visible type or member

This is due to code writing that is not standardized, and in order to eliminate these warnings, the possible methods are as follows:

1. Project--Generate, suppress limit warning, enter 1591, warning number, which is for the entire project level

2. Add code to the code to suppress the warning, note that this is only for file-level

#pragma warning disable    1591

If you want to restore the display warning prompt, use the following statement

#pragma warning restore    1591

3. Do not generate an XML document, the warning is not displayed, but this method is not used in this scenario.

C # CS1591 Missing XML Comment problem resolution for public visible types or members

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.