Где документировать функции в C или C ++? [закрыто]
У меня есть программа на C с несколькими файлами, поэтому я, например,stuff.c
который реализует несколько функций, иstuff.h
с функцией прототипов.
Как мне документировать функции в комментариях?
Если у меня есть все документы в заголовочном файле, все документы в.c
файл или дублировать документы для обоих? Мне нравится последний подход, но затем я сталкиваюсь с проблемами, когда я обновляю документы по одному из них, а не по другому (как правило, на том, где я делаю первое изменение, то есть, если я сначала изменяю файл заголовка, то его комментарии будет отражать это, но если я обновлю реализацию, изменится только эти комментарии).
Этот вопрос и его ответы также относятся к коду C ++ - см. ТакжеГде я должен разместить комментарии к документации?