Add VisualStudio GhostDoc plugin setting file
Thanks @starpeng. I'm a fan of GhostDoc. I've never encountered it creating a GhostDoc.xml file though. Could you describe that file a bit? If it contains information about how to format xml-documentation I could see it being useful for other members of the project as well to produce consistent documentation.
But as I said, I don't know what it does so any information you could share about it would be helpful.
@niik I believe the file is %SolutionFile%.GhostDoc.xml so if the solution was CompanyA.MySolution then the xml comment file would be CompanyA.MySolution.sln.GhostDoc.xml I have this file in my solution as well.
I'm running GhostDoc Pro v4.9. Seems to be settings for GhostDoc, see mine below:
Seems like something you'd probably want in source control but I imagine some teams would want to keep it out.
Thanks @rog1039! Based on that I don't think it should go in to the generic .gitignores.
I came here to submit a PR for this 👯
I ❤️ GhostDoc, but the fact that it creates a $(SolutionFile).GhostDoc.xml file for each solution I open with Visual Studio is super annoying.
In the 50+ repos (mostly .NET) I've contributed to, I've yet to see anyone actually committing this file to a repository. So for every repository, I have to make sure I don't accidentally include the file in a commit.
This makes me really want to include it by default in VisualStudio.gitignore. If you really want to commit it, it's easy to comment out the one line 😄
Is this something that you'd consider? We could either reopen this or I could submit a new PR.
@khellang I think a PR with a *.sln.GhostDoc.xml rule - with appropriate comments - is acceptable.
Having a source of truth to point to about what this file represents (and why it can be excluded from version control) always helps get these things through.
Feel free to open a PR and rally the troops to your cause 😁