Python-сообщество

Всем привет. Написал относительно не большой проект на питоне 2. Питон учил именно из-за этой разработки и серьёзного опыта кодинга на нём у меня нет. Из-за этого код проекта имеет явно не лучший вид и появилось у меня желание заказать код-ревью, дабы получить грамотных советов по работе с питоном и улучшению своего проекта.
Но тут встал следующий вопрос - как подготовить проект к код-ревью? Нужно ли схематичное описание работы проекта? Если да, то на сколько подробное? Нужно ли нашпиговать код комментариями?
Буду благодарен за любую информацию.

P.S. Проект представляет собой консольную утилиту. 330Кб кода.

Отредактировано WhiteTiger (Окт. 27, 2015 11:19:30)

WhiteTiger
если вы через месяц другой посмотрите на произвольный кусок кода и не сможете понять что он делает и/или как он работает - значит что то с ним не так=)
330кб Питон кода? ЧТо это за утилита такая. Выкладывайте код на каком нибудь ресурсе, кто нибудь да глянет.

да. На каком нить гитхабе

Нормальная такая “утилитка” на 6000-7000 строк кода.

ayb
Нормальная такая “утилитка” на 6000-7000 строк кода.

Ну оооооочень подробные комментарии.

Вы лучше напишите для чего утилитка. Может кому интересно будет.
А так буду банален. Должно быть как минимум:
http://pep8.ru/doc/pep8/
pylint
sphinx или аналогичная документация (т. е. человеческий текст об использовании а не комментарии к функциям).
Возможность одним из стандартных способов установить вашу утилиту.

Мне тоже интересно что это за утилита на 330 килобайт текста. Трудно даже представить откуда такой объем.

Да любой даже маленький проект по печати документов с GUI если не разносить по модулям потянет на 6000 строк теста. Просто, видимо, на модули не разбивался а все лепилось в один мега файл.

4kpt_III
Просто, видимо, на модули не разбивался

Может и разбивался автор не пишет.

4kpt_III
по печати документов с GUI

Так вроде консольная утилита. Но даже для GUI программы 300 Кб это много.

Отредактировано doza_and (Окт. 27, 2015 19:14:11)

> Ну оооооочень подробные комментарии.

Вот этого как раз и не нужно.

> Да любой даже маленький проект по печати документов с GUI если не разносить по модулям потянет на 6000 строк теста.

Не. Гуй увеличит число строк процентов на 10-15 не больше. На маленьком проекте 6000 строк точно не будет.

Автор вобще что-то не пишет. Тут пока полемика