How to create free Documentation for a Project?

Getting Started
,
1

Hi there,
I am new to Unity and my projects are growing. Now i have exceeded printing hello world and i want to explain to the other people who might or might not join me in the creation of my project. And as money is tight i would really prefer a free solution to this. I had the idea of leaving comments, however leaving comments in the Code does not seem to be the only possible way. I want the documentation to be more object based, so i can keep track of what components are for what reason part of some enemies and what rules would a gun prefab have to follow?
How do you document your projects?
I really want it to be something that can hold most information compact in one place so that i can give that ressource to modders or artists and they don’t have to wrap their head around all the newbie workarounds and mistakes i made. And in the best case it should be easy to maintain, so that i do not have to copy comments in the code from a to b all the time.
Thanks in advance for your recommendations on what to do and any pointers on forum entries that asked the same question before.

2

I don’t really use it but c# does have documentation comments. Basically you enter /// and it will auto generate some placeholder xml for you to fill in e.g.

/// <summary>
/// Class <c>Point</c> models a point in a two-dimensional plane.
/// </summary>
public class Point
{
    /// <summary>
    /// Method <c>Draw</c> renders the point.
    /// </summary>
    void Draw() {...}
}

Then there are tools that generate html documentation from the code comments. The output tends to be similar to the Unity docs.

1 Like