Welcome to the documentation of Metalama, a code generation and analysis framework for C#.
How to navigate this documentation?
There are typically two types of Metalama users:
- If you intend to utilize aspects written by others, begin with Using Metalama and likely conclude there.
- If you aspire to develop your own aspects, start with Getting started with Metalama to get a quick overview, then jump to Using Metalama and continue to Creating simple aspects.
Each article is assigned a complexity level, such as 100, 200, 300, following the U.S. school system. Before advancing to a level 200 article, ensure you have a solid understanding of level 100. We strive to avoid incorporating complex details into basic level articles. Occasionally, you may need to study several articles to gather comprehensive information on a specific topic.
Documentation structure
| Book | Description |
|---|---|
| Getting started with Metalama | A quick Hello, world walkthrough that shows you how to create a logging aspect and apply a simple architecture validation rule. |
| Conceptual documentation | Comprehensive and precise reference documentation. |
| Commented examples | Commented examples with varying degrees of complexity. |
| Metalama API documentation | API documentation generated from the source code. |
Getting help
If you have any questions, don't hesitate to reach out:
- Engage with us on Slack.
- Initiate a discussion on GitHub.
The source code for this documentation (excluding the API documentation) is open-source and hosted at https://github.com/postsharp/Metalama.Documentation. You can:
- Open an issue or
- Submit a PR with your proposed improvements.