Boost of work.
Apr. 9th, 2013 01:02 amКогда ежедневно выполняешь одно и то же действие, очень быстро хочется его автоматизировать.
У нас есть стандарт на оформление документации к коду, в котором говорится сколько пробелов должно быть между ключевыми словами и самим комментарием.
В конечном счете мало кто читает эту документацию из кода, гораздо проще сгенерировать веб страницу и читать от туда, но мне гораздо удобнее это делать без генерации. Можно сразу посмотреть что делает тот или иной метод и сравнить документацию с текущей реализацией.
Так получилось что мне нужно было написать тесты к интерфейсу, но документации не оказалось, а без нее тесты просто не реально написать. Я сел за написание этого документа и ежедневно тратил кучу времени на форматирование текста, что очень сильно раздражало.
Когда моё терпение кончилось, я решил написать программу, которая сама все выравнивает согласно нашему стандарту.
Потратив два вечера, я написал и протестировал свое решение на реальной документации.
Конечно решение не идеально и можно сделать еще кучу оптимизаций, но на сегодняшний день оно работает и я уже могу его пользовать.
Заодно начал выкладывать код на https://github.com/sibuser
З.Ы. Хочешь научится писать на Питоне? Просто начни писать:) Постепенно код будет становиться лучше, если задаться такой целью.
У нас есть стандарт на оформление документации к коду, в котором говорится сколько пробелов должно быть между ключевыми словами и самим комментарием.
В конечном счете мало кто читает эту документацию из кода, гораздо проще сгенерировать веб страницу и читать от туда, но мне гораздо удобнее это делать без генерации. Можно сразу посмотреть что делает тот или иной метод и сравнить документацию с текущей реализацией.
Так получилось что мне нужно было написать тесты к интерфейсу, но документации не оказалось, а без нее тесты просто не реально написать. Я сел за написание этого документа и ежедневно тратил кучу времени на форматирование текста, что очень сильно раздражало.
Когда моё терпение кончилось, я решил написать программу, которая сама все выравнивает согласно нашему стандарту.
Потратив два вечера, я написал и протестировал свое решение на реальной документации.
Конечно решение не идеально и можно сделать еще кучу оптимизаций, но на сегодняшний день оно работает и я уже могу его пользовать.
Заодно начал выкладывать код на https://github.com/sibuser
З.Ы. Хочешь научится писать на Питоне? Просто начни писать:) Постепенно код будет становиться лучше, если задаться такой целью.