👩‍💻 Doxygen

Doxygen — это кроссплатформенная система документирования исходных текстов, которая поддерживает C++, Си, Objective-C, Python, Java, PHP, C# и другие.

Пример шаблонного документирования класса:

/**
 * Описание класса.
 */
public class MyClass {
    // код класса
}

Пример документирования при помощи Doxygen:

/**
 * Описание класса.
 */
public class MyClass {
    /**
     * Описание метода.
     * @param param Описание параметра.
     * @return Описание возвращаемого значения.
     */
    public int myMethod(int param) {
        // код метода
        return param;
    }
}

Doxygen сгенерирует документацию, включая описание класса и метода, а также информацию о параметрах и возвращаемом значении.

➡️ Java Developer