const-phi / cdemo

Демонстрационная программа на C

Данный проект призван продемонстрировать особенности и нюансы работы как с языком программирования C и его компиляторами – gcc, clang или msvc, так и со специальными утилитами (tools) – make, bash, doxygen etc.

Планы

1. Дополнение примером работы с Dockerfile и docker-compose.
2. Дополнение примером работы с GitHub Actions.
3. Альтернатива пункту 2 – такая же деятельность, но в рамках standalone GitLab или GitFlic.

Полезные ссылки

1. Doxygen multi-lang В случае если необходимо писать документацию сразу на нескольких языках, можно оформить её специальным образом:

   /**
    * \~english @brief Sample method
    * \~russian @brief Пример метода
    */
   void foo();

   см. https://stackoverflow.com/a/46685789/2761685

2. Пример оформления документации Doxygen для программы на языке C – https://fnch.users.sourceforge.net/doxygen_c.html