Чуть-чуть неправильно ты меня понял.
Комментарии в doxygen-style - это хорошо, я тебе даже за это часы запишу. Но это не главное. Главное описать, как работать с программой. То есть нужно описание проги для тестировщика, а не программиста. Можно просто в readme.md добавить слова "в таком-то файле можно менять футболистов. Если поменять местами этих двоих, счет должен поменяться"
Чуть-чуть неправильно ты меня понял. Комментарии в doxygen-style - это хорошо, я тебе даже за это часы запишу. Но это не главное. Главное описать, как работать с программой. То есть нужно описание проги для тестировщика, а не программиста. Можно просто в readme.md добавить слова "в таком-то файле можно менять футболистов. Если поменять местами этих двоих, счет должен поменяться"
Но, повторюсь, комментарии тоже нужны, оставь их