Fydar.Samples is a library for maintaining code samples and generating documentation for C#.
A demo of how to use Fydar.Samples to generate samples.
Samples are kept within your project and can be presented via two mechanisms.
- File System sampling is used to present code samples.
- Sample Return is used to present the result of a method.
A demo of how to use Fydar.Samples to generate samples.
When the application is run, all static methods with the SampleReturn
attribute are invoked and their results are presented in the output.
The formatted output of the sample.
Include a reference to the project (NuGet package coming soon) in your solution.
A properly configured .csproj file.
Sample .cs
files will need to be included in the build output so the syntax highlighter will be able to operate on them.
Solution with samples included in the samples directory.
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.