BE0031: Ignoring invalid XML comments file '[file]'. Reason: [reason]

Warning BE0031: Ignoring invalid XML comments file '[file]'. Reason: [reason]

Cause

This warning occurs if an XML comments file being used as a documentation source is found to be invalid. The reasons for an invalid XML comments file are typically ill-formed content such as unclosed elements or invalid entities.

Solution

Find the invalid XML comments file and fix the invalid comments either by editing the comments in the source code or the XML comments file directly. If the XML comments file is not under your control, such as one from a NuGet package or third-party product, contact the owner to have them fix the error and publish an update with the corrected XML comments file.

This is only a warning and the build will continue. The only noticeable side-effect is that member list topics may not contain descriptions for inherited members from types documented by the invalid XML comments file.

See Also

Other Resources