Несколько лет назад я написал небольшую утилитку для подсчёта количества комментариев. Было очень интересно подсчитать и проанализировать комментарии в проектах над которыми работал, а впоследствии и в крупных Open Source проектах. В этой статье представлены результаты полученные для распространённых Open Source проектов.
Таблица результатов предоставлена ниже и состоит из следующих колонок:
1. Название проекта и версия.
2. Количество символов кода.
3. % комментариев от общего объёма кода.
4. Отношение количества строк кода к количеству комментариев.
5. Количество слов todo+fixme. Показатель того, сколько ещё осталось доработать в проекте.
Примечание об анализе:
В Zlib анализировались все файлы кроме директории contrib.
В Qt анализировалась папка qt-everywhere-opensource-src-4.6.4\src за исключением 3rdparty.
В wikimedia анализировались все папки кроме languages (спасибо за совет).
В Ogre была исключена папка Samples.
Стоит отметить, что при подсчёте не учитывался первый комментарий файла, так как скорее всего это — копирайт. Из приведённых результатов видно, что в среднем количество комментариев составляет порядка 15%. Конечно выделяется OpenOffice, имея 6557 fixme + todo. Из этих комментариев:
Если хотите провести этот тест самостоятельно, ссылка на утилиту: unick-soft.ru/soft/commentCounter.zip
Спасибо VBart за ссылку на сервис www.ohloh.net, в котором можно найти большое количество open source проектов. Кроме всего прочего сервис отображает статистику количества комментариев в них.
Таблица результатов предоставлена ниже и состоит из следующих колонок:
1. Название проекта и версия.
2. Количество символов кода.
3. % комментариев от общего объёма кода.
4. Отношение количества строк кода к количеству комментариев.
5. Количество слов todo+fixme. Показатель того, сколько ещё осталось доработать в проекте.
| Название и версия | Объём кода | % комментариев | строк кода / комментариев |
todo+fixme |
|---|---|---|---|---|
| Apache OpenOffice 3.4.1 | 279 М | 16.3 % | 3.3 | 6557 |
| Mozilla Firefox 14.0.1 | 163 M | 25.5 % | 4.5 | 1338 |
| Qt 4.6.4 | 57 M | 19.9 % | 7.0 | 395 |
| Blender 2.63 | 71 M | 10.9 % | 6.0 | 1477 |
| Gimp 2.8.2 | 33 M | 7.7 % | 10.6 | 227 |
| OGRE 1.9.0 | 23 M | 23.5 % | 3.5 | 421 |
| Inkscape 0.48.2 | 19 M | 18.7 % | 5.0 | 1556 |
| VLC media player 2.1.0 | 20 M | 14.7 % | 6.3 | 1155 |
| Php 5.4.6 | 45 M | 10.6 % | 6.2 | 277 |
| Mediawiki 1.19.1 | 15 M | 14.8 % | 5.0 | 546 |
| 7-Zip 920 | 4.2 M | 5.9 % | 25.6 | 0 |
| Zlib 1.2.7 | 694 K | 40.9 % | 4.0 | 0 |
Примечание об анализе:
В Zlib анализировались все файлы кроме директории contrib.
В Qt анализировалась папка qt-everywhere-opensource-src-4.6.4\src за исключением 3rdparty.
В wikimedia анализировались все папки кроме languages (спасибо за совет).
В Ogre была исключена папка Samples.
Стоит отметить, что при подсчёте не учитывался первый комментарий файла, так как скорее всего это — копирайт. Из приведённых результатов видно, что в среднем количество комментариев составляет порядка 15%. Конечно выделяется OpenOffice, имея 6557 fixme + todo. Из этих комментариев:
- 50 комментариев выглядят так: «TODO: check overflow!».
- Около 10: «TODO TODO TODO: this O(n) search really sucks ...».
- 68 комментариев типа «get rid of».
- 94 комментария «TODO document me»
Если хотите провести этот тест самостоятельно, ссылка на утилиту: unick-soft.ru/soft/commentCounter.zip
Спасибо VBart за ссылку на сервис www.ohloh.net, в котором можно найти большое количество open source проектов. Кроме всего прочего сервис отображает статистику количества комментариев в них.