Longobard
написал 6 июля 2004 года в 00:43 (877 просмотров)
Ведет себя
как мужчина; открыл 291 тему в форуме, оставил 2499 комментариев на сайте.
Как их следует оформять (в смысле каковы тут правила «хорошего тона»)? А то у меня я так посмотрел — не сорцы а помойка :) Ни тебе комментов, длинные имена переменных то имя_переменной то ИмяПеременной то Имя_переменной и т.д. :) Короче надо исправлять. Чего вы пишете в начале сорца? В комментах. А?
Последние комментарии
- OlegL, 17 декабря в 15:00 → Перекличка 21
- REDkiy, 8 июня 2023 года в 9:09 → Как «замокать» файл для юниттеста в Python? 2
- fhunter, 29 ноября 2022 года в 2:09 → Проблема с NO_PUBKEY: как получить GPG-ключ и добавить его в базу apt? 6
- Иванн, 9 апреля 2022 года в 8:31 → Ассоциация РАСПО провела первое учредительное собрание 1
- Kiri11.ADV1, 7 марта 2021 года в 12:01 → Логи catalina.out в TomCat 9 в формате JSON 1
ecobeing.ru
Экология и вегетарианство на благо всем живым существам Планеты.
Ну, загляни, скажем, в сырцы MPlayer’а, они довольно неплохо оформлены.
Good Luck,
UT
Это шутка? Сорцы Mplayer’а — это одна из самых запущеных помоек, что я видел.
LONGOBARD:
Почитай The Practice of Programming (у нас «Практика программирования», Бином, Невский Диалект, 2001) Кернигана и Пайка. Или посмотри сорцы Plan9 from Bell Labs, или сорцы старого UNIX’а V6 или V7 — их можно взять на ftp’шнике The Unix Preservation Society. На худой конец — прекрасный пример хорошо офрмленных исходников, как ни странно, — Sendmail.
Вы наверное меня не так поняли. Каков ваш стиль оформления сорцов? Мой такой:
А как вы?
я примерно так:
Переменные пишу как
имя_длинной_пересенной.
Пример
Имена функций:
имя_долгой_функции()
пример
Имена виджетов:
действие_btn для button
Имена callback-ов:
void on_действие_btn_clicked(….)
{
…
}
А я так:
Вообще-то за indent’ом должна следить одноименная прога либо функция редактора. В *Emacs, например, Enter+TAB или лучше C-j обычно помогают.
Я так понял, работаете один а не в команде. Тогда все просто. Если берете какой-нибудь старый сырец (полугодичной, скажем, выдержки) и практически сходу врубаетесь в то, что он делает (внимание, тонкость: как делает — отдельный разговор) то все в порядке. А вообще, документировать код — это арт. Не ко всем и не сразу приходит.
P.S. ИМХО, самый запущенный код из тех, что я видел — это Dungeon Crawl
смотри , я например очч люблю и уважаю как Gnome-овские сурсы сделаны .
по поводу длинных имён …. ну к примеру ничегоне вижу зазорного в таком имени макроса G_TYPE_CHECK_CLASS_CAST
а вообще не плохо почитать Extreem Programming на эту тему .