Document Code in C# Scripts

[jimenezz22]

Scope

We need to document all the code in the files inside Assets/Scripts path

To do:

• Understand the all the code/classes/methods/functions in the files and their conecctions with other classes in other scripts
• Document these files in a format similar to JavaDoc for example, but for C# scripts.
• Explain what each class, each method, each function, each flow control, etc. does. We need to have all these scripts fully documented.

How to apply?

Please follow the contribution guidelines in the readme file

[Iwueseiter]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi @jimenezz22 can I work on this?
I'm a frontend and smart contract developer, I'm also a technical writer and I'd love to contribute to this project.

How I plan on tackling this issue

Here are the links to some comprehensive documentations I've contributed here on onlydust that have also been merged: Flex-NFT-Marketplace/Flex-Marketplace-Contract#107,
sivicstudios/starkludo#102,
horuslabsio/tokenbound-contract-docs#12

[NueloSE]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

@jimenezz22, Am a software developer with some intermidate level expertise in C# scripting around MonoBehaviour and SceneManager. With some proficiency level in codebase analyzing, Identifying relationships between classes and methods and documenting them comprehensively. My experience spans across UI management, which aligns well with the scripts provided.

How I plan on tackling this issue

Observing the files in the codebase for example: Assets/Scripts, i would approach it as follows:

using UnityEngine;
using System.Collections;
using System.Collections.Generic;

/// <summary>
/// Represents an entrance to an area in the game world.
/// </summary>
public class AreaEntrance : MonoBehaviour
{
    /// <summary>
    /// Gets or sets the name of the transition associated with this entrance.
    /// </summary>
    public string transitionName;

    /// <summary>
    /// Initializes the component.
    /// </summary>
    void Start()
    {
        // Check if the player is transitioning to this area
        if (transitionName == PlayerController.instance.areaTransitionName)
        {
            // Move the player to the current position of this entrance
            PlayerController.instance.transform.position = transform.position;
        }

        // Fade from black and stop fading between areas
        UIFade.instance.FadeFromBlack();
        GameManager.instance.fadingBetweenAreas = false;
    }

    /// <summary>
    /// Called every frame.
    /// </summary>
    void Update()
    {
        // Currently empty, but could be used for continuous checks or actions
    }
}

• In addition I would adhere to some general approach for documenting C# scripts in Unity, like:

1. Use XML documentation comments (///) for classes, methods, fields, and properties.
2. Provide a brief summary for each class, method, field, and property.
3. Explain the purpose and functionality of each part of the script.
4. Include parameters and return values for methods.
5. Describe the behavior of event handlers like Update() and OnTriggerEnter2D().
6. Use consistent naming conventions throughout the script.
7. Group related elements together (e.g., all public variables at the top, private variables below, etc.).
8. Add comments to explain complex logic or important decisions made in the code.

previous code doc by me:

• Tokenbound-contract
• cairo-book

kindly assign

ETA 3-5days

[jimenezz22]

Hi @NueloSE @Iwueseiter
thank you for your interests to contribute to ByteBeats, we will start assigning issues when the ODHack 9 starts on October 24 and issues will be assigned through OnlyDust

[zleypner]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi! I’m Anwar a Software Developer with +3 years of experience, and I would love
continue making contribution to this project
I'm also a member of the Dojo Coding community From CR.

How I plan on tackling this issue

I will carefully go through each file, class, method, and function, and identify how they connect with other scripts and components.
I will explain:
What the class is responsible for.
The purpose of each method and its parameters.
The logic behind flow controls

The documentation will ensure that the entire structure is clear and concise, making the code easier to understand and maintain.

For reference, I have experience in documenting projects, including my contribution to Horus Labs Tokenbound Contract Docs, and I have worked on documentation tasks in ByteBeastsBackend.

[akintewe]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I have vast experience producing clear, comprehensive documentation in both JavaScript and C#. My expertise with C# development has given me a solid understanding of object-oriented programming ideas and documentation guidelines.
:)

How I plan on tackling this issue

For this documentation work, I would first go through all of the scripts in the Assets/Scripts directory to understand their functionality and linkages. I'd use C# XML documentation comments to describe classes, methods, and properties, assuring IntelliSense compatibility. I would focus on documenting method arguments, return values, and class relationships in C#, comparable to JavaDoc approach. I would be excited if i am granted to work on this task :)

[martinvibes]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

ello @ i'm a frontend developer and an experienced technical writer i would love to work on this issue
Pleasee kindly assign :)

[od-hunter]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello can I be assigned this please? I am a blockchain developer and I'm also good at documentations. Below are some of the documentations I've done that were merged:

dojoengine/book#308,
keep-starknet-strange/joyboy#143,
Scaffold-Stark/ss2-docs#31,
horuslabsio/Starknet-Scaffold#94,
hyli-org/examples#15,
hyli-org/examples#16,
horuslabsio/tokenbound-contract-docs#11.

How I plan on tackling this issue

Here are some documentations I did that were merged:ByteBuildersLabs/ ByteBeastsFrontend #96

Hello can I be assigned this please? I am a blockchain developer and I'm also good at documentations. Below are some of the documentations I've done that were merged:

dojoengine/book#308,
keep-starknet-strange/joyboy#143,
To write a comprehensive and correctly formatted documentation:

1. I’ll start by carefully reviewing each C# file inside the Assets/Scripts directory, to understand how each class, method, or function interacts with others, noting dependencies, inheritance, and flow control.
2. ⁠I’ll make sure to add comments, and tags like
   , , and to explain functionality.
3. ⁠I’ll run a build and check if all tooltips and comments are properly displayed in my IDE.

Please I’m ready to work, assign me please.

[suhas-sensei]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

i have experience in game dev as well as blockchain previously as personal projects and OS, so hoping to make use of them here and mark my first odhack contribution

How I plan on tackling this issue

let me put my documentation skills to use

[mexes20]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello, can I be assigned to work on this issue as a first time Contributor.

ETA: One Day