Review/update documentation of the 'debug' C# compiler option

[cremor]

Could you please review this page and make sure that it is actually correct? Because there are a few posts that claim that parts of that documentation is wrong or outdated.

A good starting point is this question on StackOverflow. The two highest voted answers both say that this documentation is outdated and they also provide links to further information.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 3029908f-c2ff-3620-7d51-b9f6a3b768dc
• Version Independent ID: 0f310c2a-3dc6-54a4-5014-264d7f727f2f
• Content: -debug (C# Compiler Options)
• Content Source: docs/csharp/language-reference/compiler-options/debug-compiler-option.md
• Product: dotnet-csharp
• GitHub Login: @BillWagner
• Microsoft Alias: wiwagn

[rpetrusha]

Thanks, @cremor, for your feedback. We'll have to investigate before we can revise the documentation.

[tmat]

https://github.com/dotnet/roslyn/blob/master/docs/compilers/CSharp/CommandLine.md has up to date documentation of the switch.

[BillWagner]

The current doc is missing /debug:portable and /debug:embedded descriptions.

The other key change i that /debug:pdbonly should be called out as a Windows only debug format. The /debug:portable would be preferred.

[tmat]

Also /debug:pdbonly is exactly the same as /debug:full. It's not really a Windows-only switch.
It will produce Portable PDB on Linux and Windows PDB on Windows.

[tmat]

You can link https://github.com/dotnet/designs/blob/master/accepted/diagnostics/debugging-with-symbols-and-sources.md#pdb-formats that discusses the PDB formats.