CsToMd

This extension contains a CustomTool File Generator, which generates a markdown file from the .cs file by stripping the comments /*md and md*/.

How to use

• In properties of your .cs file, set the CustomTool property to CsToMd.
• Save the .cs file with /*md and md*/ comments in it (or without - it will work too).
• Check the generated .md file under the .cs file in Solution Explorer.

Check the screenshots from the Visual Studio 2017 here: https://github.com/dadhi/CsToMd/blob/master/README.md

Examples

• A simple example: https://github.com/dadhi/CsToMd/blob/master/CsToMdTest/NiceDoc.cs with the result https://github.com/dadhi/CsToMd/blob/master/CsToMdTest/NiceDoc.md
• Full-fledged example from the DryIoc project: https://github.com/dadhi/DryIoc/blob/master/docs/DryIoc.Docs/Decorators.cs with the result https://github.com/dadhi/DryIoc/blob/master/docs/DryIoc.Docs/Decorators.md

The extension code

For those who wants to do a similar thing for VS Code, JB Rider, or in MSBuild, here is the actual code:

var inputLines = inputFileContents.Split(new[] { NewLine }, StringSplitOptions.None);

var outputBuilder = new StringBuilder(inputLines.Length * 20);
var lastLineIndex = inputLines.Length - 1;
for (var i = 0; i < inputLines.Length; i++)
{
      var line = inputLines[i];
      if (!string.IsNullOrWhiteSpace(line))
      {
           var parts = line.Split(new[] { @"/*md", @"md*/" }, StringSplitOptions.None);
           if (parts.Length != 1)
                line = parts.Any(s => !string.IsNullOrWhiteSpace(s)) ? string.Concat(parts) : null;
      }

      if (line != null)
      {
           if (i < lastLineIndex)
                outputBuilder.AppendLine(line);
           else
                outputBuilder.Append(line);
       }
}

var output = outputBuilder.ToString();