1
Is there a way to exclude auto-generated code files from documentation?
Question asked by Mati Kos - 2/1/2022 at 7:45 AM
Answered
I have lots of files in our codebase that are generated by the Entity Developer. Adding comments will break the code. So I would like to if possible set a rule.
Is there a way to do it?

The header of files I want to exclude reads as follows:

//------------------------------------------------------------------------------
// This is auto-generated code.
//------------------------------------------------------------------------------
// This code was generated by Entity Developer tool using EF Core template.
// CBS
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
//------------------------------------------------------------------------------

1 Reply

Reply to Thread
0
Serge B. Replied
Employee Post Marked As Answer
Hi Mati,

You can get GhostDoc to ignore your auto-generated code files using Solution Options -> Solution Ignore List - this will exclude the file patterns you add from the Document Project action and GhostDoc won't even parse these files.

For more information and a sampler for the file patterns please see the KB article - https://support.submain.com/kb/a52/file-path-patterns.aspx

Thanks!


Serge Baranovsky
SubMain Software
(800) 936-2134

Reply to Thread