P3Model.Annotations 0.1.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Standard 2.0
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package P3Model.Annotations --version 0.1.0
NuGet\Install-Package P3Model.Annotations -Version 0.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="P3Model.Annotations" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add P3Model.Annotations --version 0.1.0
#r "nuget: P3Model.Annotations, 0.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install P3Model.Annotations as a Cake Addin
#addin nuget:?package=P3Model.Annotations&version=0.1.0

// Install P3Model.Annotations as a Cake Tool
#tool nuget:?package=P3Model.Annotations&version=0.1.0

P3 Model Annotations for .net

CC BY-SA 4.0

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.

This library is a part of P3 Model - a tool to navigate throughout complex systems from all important perspectives.

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 informations 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

If you haven't check out main P3 Model repository then we strongly encourage you to do it.

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.

Contribution

Join us and help building P3 Model. Let's solve the problem of outdated and useless documentation together.

To start contributing or discussing just open GH 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.

CC BY-SA 4.0

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on P3Model.Annotations:

Package Downloads
P3Model.Parser The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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.3.0-preview07 70 2/14/2024
0.3.0-preview06 85 1/25/2024
0.3.0-preview05 177 12/15/2023
0.3.0-preview04 70 12/14/2023
0.3.0-preview03 178 10/7/2023
0.3.0-preview02 104 9/25/2023
0.3.0-preview01 62 9/16/2023
0.2.0-preview9 82 9/2/2023
0.2.0-preview8 100 8/25/2023
0.2.0-preview7 99 7/21/2023
0.2.0-preview6 73 7/21/2023
0.2.0-preview5 74 7/21/2023
0.2.0-preview4 82 7/11/2023
0.2.0-preview3 98 6/10/2023
0.2.0-preview2 77 6/2/2023
0.2.0-preview10 74 9/6/2023
0.2.0-preview1 67 6/2/2023
0.1.0 140 4/15/2023

basic annotations for domain perspective