NoesisVision Annotations is a set of metadata attributes that you can use in you .net code to enrich it with information about domain model, people aspects, used patterns and more.
Working code is enough for the machine that executes it but not enough for people to understand it.
A lot of information is already in the code, but much information is missing because they are not needed for the compiler.
Thus we need to add metadata about:
- business concepts are not represented directly in the code (e.g. domain modules, processes, etc.)
- intent to use architecture or design patterns
- rationale of design decisions
- people responsible for maintenance and development of certain parts of the system
- etc.
We believe that enriching code with these additional aspects can help us in:
- better understanding of the design when working with code directly in IDE
- automatically generating always up-to-date documentation - Living Documentation
- automation architecture testing
- Add NoesisVision.Annotations package to each .net project you want to add metadata to.
- Add appropriate attributes to your code.
NoesisVision is a tool to automatically generate documentation from your source code.
Generated documentation is based on information already present in the code and additional metadata added with annotations and JSON or Markdown files.
Each technology like .net or Java has its own tooling. This library is a part of .net tooling.
If you'd like to find more information about NoesisVision check the project's page.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
