23 октября 2014, 23:04
MintМы пишем программу
Забавно, я давно вот замечаю, что есть такая привычка, когда пишешь программы, то в комментариях к коду (любая более-менее хорошая программа содержит комментарии, поясняющие что здесь или там творится — в наиболее сложных местах), то часто это пишется от лица «нас», например «здесь мы получаем такой-то результат», «а здесь мы делаем так, потому что раньше вычисляли то-то, используя наш генератор». Я давно стал думать что это за «мы» такие прописываются в моих программах, и кажется, что иначе вообще невозможно написать и сформулировать. Вот он — голос социума! :)))
Потом правда я понял, что возможно довольно-таки легко перейти к безличностному варианту и фразы, означенные выше, приобретут такой вид «здесь получается такой-то результат», «а здесь делается так, потому раньше вычислилось то-то, с использованием генератора».
Можно конечно и от собственного лица писать, но это допустимо только в личных проектах и как-то непрофессионально (особенно если ещё и на русском языке). Самый правильный вариант получается безличностный — он работает и в случае, когда этот код придётся потом поддерживать и развивать команде программистов, и когда какому-то одному (и, возможно, не тебе).
Потом правда я понял, что возможно довольно-таки легко перейти к безличностному варианту и фразы, означенные выше, приобретут такой вид «здесь получается такой-то результат», «а здесь делается так, потому раньше вычислилось то-то, с использованием генератора».
Можно конечно и от собственного лица писать, но это допустимо только в личных проектах и как-то непрофессионально (особенно если ещё и на русском языке). Самый правильный вариант получается безличностный — он работает и в случае, когда этот код придётся потом поддерживать и развивать команде программистов, и когда какому-то одному (и, возможно, не тебе).
(24):
Diamir, sasha, Eya, Mikhayyam, ashtavakra, forsuasson, Bambuka, Jaisonkrid, Vita, liya, jedi, spart, pchelkine, Era, Atya, asyoulike, konstruktor, Biryza, Amitola, vitaly73, Olle, Upananda, tnc, syuzhetina
19 комментариев
Я всегда пишу от имени программы в комментах. Может быть потому что по английски… например «Writes back to database, hides panel»
От своего имени только такие комментарии:
This normally doesn't work but I've added it anyway as I am delusional optimist
А вторым тоже иногда бывает, ага ) Когда эмоциональное что-то. например, когда два дня искал ошибку, а оказалось потом что по запарке не ту букву где-то написал или ещё что-то глупое :)))
А вообще комментарии очень иногда интересно читать, как будто ты подглядываешь как человек думает.
А ведь есть еще индийский код. Вот это вообще бывает смешно, это как индийское кино — даже без комментариев! :) Как будто ребенок писал :)
А ещё есть очень популярное такое правило:
«Пишите код так, как будто сопровождать его в дальнейшем придётся жестокому психопату, который знает, где вы живёте» :)))
Я помню читал в институте текст компилятора паскаля Вирта, меня поразила гениальная минималистичность комментариев. Они были точно в тех местах, где становилось непонятно что происходит.
Ситуация такова — если работается хорошо, все идет правильно — то нужно что то кому-то объяснять? Нет!
Но если делаешь что то ясно не правильное, то всегда хочется объяснить, ну типа ситуация такая или что еще. Нет чтобы взять и сказать — ну блин лень мне это делать, лень и все. Да и лень — лишнее, просто ничего не нужно говорить. Кому это интересно? Да никому.
Интересно ведь что-то сделанное хорошо, чему можно поучиться. А это чаще и в комментариях не нуждается, все само-очевидно.
Но! Иногда чтобы понять что это хорошо нужно хоть понимать предмет. И тут начинается искусство ради искусства.
Но все еще хуже, если смотреть дальше. Поскольку всегда можно сделать лучше. Даже очень хорошо сделанное не идеально. И вот тут возникает вопрос — как мы способны видеть что даже самое идеальное — не идеально? С чем мы сравниваем? С идеями? А идеи откуда берутся? Ну явно ж не мы их делаем, поскольку все то что мы делаем — не идеально.
Как японцы в России — «дети у вас красивые, а вот то что вы руками делаете никуда не годиться». Японцы, к слову, вообще маньяки в смысле попыток сделать все идеально.
Ну да ладно :) Интересны мысли.
Я думаю комментарии — это отражение, крата мышления. Поэтому там можно разглядеть как это работает, как все описывается и почему.
"… Тут надо будет тебе пробежаться по всему массиву и посмотреть значения которые...")))
Но если от имени этого мы появляются отношения с неким предполагаемым коллективным, которые в данный момент не имеют никакой практической цели, то это уже болотные запахи :)
только несколько в другом контексте.
но я не разработчик, поэтому вряд ли, корректно смогу описать )
хотя и могу поделиться метафорой )