Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kitbashery/unity-markdown-generator
Generate .md Markdown Documentation from Unity C# script assets.
https://github.com/kitbashery/unity-markdown-generator
csharp documentation-generator markdown markdown-parser monoscript unity unityasset unityeditor
Last synced: about 5 hours ago
JSON representation
Generate .md Markdown Documentation from Unity C# script assets.
- Host: GitHub
- URL: https://github.com/kitbashery/unity-markdown-generator
- Owner: Kitbashery
- License: mit
- Created: 2023-04-25T20:33:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-28T19:30:22.000Z (3 months ago)
- Last Synced: 2024-08-28T21:10:57.418Z (3 months ago)
- Topics: csharp, documentation-generator, markdown, markdown-parser, monoscript, unity, unityasset, unityeditor
- Language: C#
- Homepage: https://kitbashery.com/
- Size: 53.7 KB
- Stars: 19
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://unity3d.com/get-unity/download)
[](https://github.com/Kitbashery/Unity-Markdown-Generator/blob/main/LICENSE)
[](https://github.com/Kitbashery/.github/blob/main/.github/CONTRIBUTING.md)
# Unity-Markdown-Generator
Generate .md Markdown Documentation from Unity C# script assets.
## Usage:
Right-click a script asset then click "Generate Markdown Documentation".
## Limitations:
- Only documents the class that shares the script file name.
- Namespace names and assembly names must match.
- Only documents public properties, methods and fields.
- XML Summary comment support is WIP.
## Comment Support:
- Tooltip attributes for properties.
- Parameter XML comments for methods.
## Example:
#### The script should turn code structured like this:
```
Namespace myNamespace.space
{
///
/// Test class summary.
///
public class TestClass
{
[Tooltip("My tooltip text.")]
public int property = 0;
///
/// Property2 summary.
///
public int property2 = 1;
///
/// Test method summary.
///
/// param1 summary
/// param2 summary
/// param3 summary
public void Test(int param1, string param2, int param3 = 1)
{
}
}
```
#### To this output:
```
# TestClass:
Test class summary.
### Namespace:
myNamespace.space
## Properties:
| Type | Name | Description | Default Value |
|:------------|:-----|:--------------------|:--------------|
| `int` | property | My tooltip text. | 0 |
| `int` | property2 | Property2 summary. | 1 |
## Methods:
| Name | Summary | Parameters | Returns |
|:-----|:-------------|:-----------|:--------|
| Test | Test method summary. | `int` param1 "param1 summary" , `string` param2 "param2 summary", `int` param3 "param3 summary" = 1 | `Void` |
```
#### Rendered:
# TestClass:
Test class summary.
### Namespace:
myNamespace.space
## Properties:
| Type | Name | Description | Default Value |
|:------------|:-----|:--------------------|:--------------|
| `int` | property | My tooltip text. | 0 |
| `int` | property2 | Property2 summary. | 1 |
## Methods:
| Name | Summary | Parameters | Returns |
|:-----|:-------------|:-----------|:--------|
| Test | Test method summary. | `int` param1 "param1 summary" , `string` param2 "param2 summary", `int` param3 "param3 summary" = 1 | `Void` |
---
The name Kitbashery & all associated images Copyright © 2023 Kitbashery. All Rights Reserved.
"Unity", Unity logos, and other Unity trademarks aretrademarks or registered trademarks of Unity Technologies.
Notice: This script is an internal tool of Kitbashery and not part of Kitbashery's product library and is provided AS IS. The name Unity is only used to elaborate on what technology stack this parser is for.