RecordVisitors – xml docs – part 6

Now it is time to write technical documentation  – XML comments to the rescue – first,read the https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/ .

Second,in order to minimize work,make the classes private / internal . See what I REALLY need to use the project – it remains some interfaces and extension methods.

It was helpful

1. putting warning as errors at csproj level
2. dotnet watch – to re-test the project each time some changes at the files occur :

dotnet watch test –project AutomatedTestRecord

Also,I have used https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.internalsvisibletoattribute?view=net-5.0 

[assembly: InternalsVisibleTo(“AutomatedTestRecord”)]

in order that the test project works .

Next,I wanted something simple to generate the documents . I know about Sandcastle – https://github.com/EWSoftware/SHFB,however,it was too much for me. I opted for https://github.com/ap0llo/mddocs

You can see the final result here : https://ignatandrei.github.io/RecordVisitors/RecordVisitors/