https://github.com/fydar/fydar.samples

A library for maintaining code samples and generating documentation.
https://github.com/fydar/fydar.samples

csharp

Last synced: 9 months ago
JSON representation

A library for maintaining code samples and generating documentation.

• Host: GitHub
• URL: https://github.com/fydar/fydar.samples
• Owner: fydar
• Created: 2021-10-04T03:24:42.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-01T16:05:58.000Z (about 2 years ago)
• Last Synced: 2025-09-30T09:35:46.016Z (9 months ago)
• Topics: csharp
• Language: C#
• Homepage: https://fydar.dev/portfolio/samples
• Size: 460 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Codeowners: docs/CODEOWNERS

Awesome Lists containing this project

README

          


  

  Fydar.Samples



**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.



## 🔧 Installation

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.



## ⚖ License

This work is licensed under a [Creative Commons Attribution-NonCommercial 4.0 International License](http://creativecommons.org/licenses/by-nc/4.0/).

[![Creative Commons License](https://i.creativecommons.org/l/by-nc/4.0/88x31.png)](http://creativecommons.org/licenses/by-nc/4.0/)