P3Model.Annotations
0.3.0-preview04
Prefix Reserved
See the version list below for details.
dotnet add package P3Model.Annotations --version 0.3.0-preview04
NuGet\Install-Package P3Model.Annotations -Version 0.3.0-preview04
<PackageReference Include="P3Model.Annotations" Version="0.3.0-preview04" />
paket add P3Model.Annotations --version 0.3.0-preview04
#r "nuget: P3Model.Annotations, 0.3.0-preview04"
// Install P3Model.Annotations as a Cake Addin
#addin nuget:?package=P3Model.Annotations&version=0.3.0-preview04&prerelease
// Install P3Model.Annotations as a Cake Tool
#tool nuget:?package=P3Model.Annotations&version=0.3.0-preview04&prerelease
P3 Model tools and libraries for .net
In this repository you can find all tools and libraries that facilitate use of P3 Model in .net.
P3 Model is a tool to navigate throughout complex systems from all important perspectives.
If you haven't check out main P3 Model repository then we strongly encourage you to do it.
Annotations
P3 Model 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.
Introduction
Working code is enough for machine that execute it but not enough for people to understand it.
A lot of information is already in the code base but many information are missing because they are not needed for the compiler. Thus we need to add metadata about:
- business concepts not represented directly in the code (e.g. domain model boundaries, 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 this 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
Usage
To use P3 Model Annotations simply add NuGet package to your C# project and start annotating your code.
Project with examples is coming soon so stay tuned.
Parser
P3 Model Parser is a tool that generate documentation from C# source code enriched with metadata like: annotations, markdown files and more.
Examples of use and integration manual is coming soon so stay tuned.
Contribution
Join us and help building P3 Model. Let's solve the problem of outdated and useless documentation together.
To start contributing you can:
- join our discussions in main repository
- open issue in this repository and write your proposition or question
License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- JetBrains.Annotations (>= 2022.3.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on P3Model.Annotations:
Package | Downloads |
---|---|
P3Model.Parser
P3 Model Parser is a tool that generate documentation from C# source code enriched with metadata like: annotations, markdown files and more. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on P3Model.Annotations:
Repository | Stars |
---|---|
itlibrium/DDD-starter-dotnet
Sample implementation and comparison of various approaches to building DDD applications. Useful as a baseline to quickly start a DDD dot net project.
|
Version | Downloads | Last updated |
---|---|---|
0.4.0 | 91 | 5/17/2024 |
0.4.0-preview01 | 72 | 5/11/2024 |
0.3.0-preview07 | 71 | 2/14/2024 |
0.3.0-preview06 | 86 | 1/25/2024 |
0.3.0-preview05 | 198 | 12/15/2023 |
0.3.0-preview04 | 70 | 12/14/2023 |
0.3.0-preview03 | 229 | 10/7/2023 |
0.3.0-preview02 | 126 | 9/25/2023 |
0.3.0-preview01 | 62 | 9/16/2023 |
0.2.0-preview9 | 97 | 9/2/2023 |
0.2.0-preview8 | 101 | 8/25/2023 |
0.2.0-preview7 | 112 | 7/21/2023 |
0.2.0-preview6 | 73 | 7/21/2023 |
0.2.0-preview5 | 74 | 7/21/2023 |
0.2.0-preview4 | 104 | 7/11/2023 |
0.2.0-preview3 | 111 | 6/10/2023 |
0.2.0-preview2 | 77 | 6/2/2023 |
0.2.0-preview10 | 86 | 9/6/2023 |
0.2.0-preview1 | 67 | 6/2/2023 |
0.1.0 | 146 | 4/15/2023 |
assembly version fix