In a Web API 2 project, in the project properties, I have enabled the output of an XML documentation file.

By default, Visual Studio 2013 wants to check this into TFS. I'm pretty sure that I'm going to exclude it, but wondered what the general opinion is on this?

  • 1
    In what folder does this file generate? What is contained in it? At minimum, the bin folder should not be checked in. – pierrepret22 Jun 13 '14 at 10:00
  • You're right, it's generating to the bin folder. I completely missed that fact. – Adrian Thompson Phillips Jun 13 '14 at 10:33

If a file 'X' can be thrown away and always completely re-generated from files that are in source control, then the general rule is that file 'X' should not be placed in source control.

The main exceptions to this rule are:

  • There are rare scenarios where the file needs to be edited manually and those edits need to be preserved.
  • If generating the file is time consuming or otherwise costly/inconvenient and the file is expected to change only rarely. In this case can it be beneficial to put the file under source control anyway to speed up the build process.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.