Как правильно писать код?
На протяжении свой карьеры программиста, я неоднократно сталкивался с тем, что программисты не умеют писать код. Причем это может касаться как начинающих так уже и очень опытных людей. Честно говоря, по моему мнению существуют единицы, которые действительно умеют это делать. Я не претендую на полноту освещение проблемы и на то что мое мнение правильное, а рассмотрю ее со своей точки зрения.
На мой взгляд не существует и не может существовать единого стандарта и каждый человек волен выбирать и адаптировать свои собственные подходы к программированию. Но есть некоторый набор практик, который помогает в подавляющем большинстве случаев.
Прежде всего хочется обратится к первоистокам проблемы. Что вообще не так и зачем надо что-то менять. Я думаю, что мечтой каждого программиста, является писать код максимально быстро и максимально красиво, причем чтоб все четко работало с первого раза. Это позволит чаще читать фишки и пить кофе с тестировщицами, для особо ярых даст больше времени для для развития себя как специалиста.
Одно из основных отличий профессионального программиста от новичка является система приоритетов. Как правило сделать код работающим очень не сложно, сделать его понятным намного сложнее (желательно конечно чтоб при этом он остался работающим). Поэтому профессионал зачастую больше времени проводит за рефакторингом чем за дебагом, что само по себе уже хорошо, однако хотелось бы и момент рефакторинга сократить до минимума.
Итак основные идеи, которые могут помочь писать код лучше
Имей идею
В любой вашей реализации должна быть идея, это как линия которая проходит через всю функциональность и связывает ее воедино. До того как сесть что-то писать, вы должны более менее представлять как это все будет работать, какие есть блоки, как они друг с другом взаимодействуют. Не садитесь писать просто так, придумайте концепцию, так и интереснее и зачастую результирующий код станет понятнее. Естественно уже придумав что-то стоит максимально оставаться в рамках этой концепции, не стоит менять все при первых проблемах, проблемы будут всегда. Также не стоит лениться и со словами, “да ладно и так затащит” втыкать какуюто затычку. Это к добру не приведет.
Идеала нет
А хочется конечно, чтоб он был, но его в 99.(9)% нет. Не стоит пытаться сделать код идеальным, получится еще хуже потратится намного больше времени. Это просто борьба с ветряными мельницами, все же нам платят за то что наше приложение работает а на за то, как оно шикарно написано. Часто поиски идеала приводят к постоянным сменам концепций, бесконечным переписыванием одного и того же, в конечном итоге надоедает, человек все бросает, затыкает все затычкам и “да ладно и так затащит”. Должно быть хорошо и удобно, идеал это не удел инженеров это удел поэтов, а программисты все таки инженеры.
Сохраняй фокус
Одной из основных проблем особенно у новичков является копание в деталях. Надо фокусироваться на 1 задаче в единицу времени. Что я хочу сказать, вы пишете какую-то функцию, натыкаетесь на какой-то не простой момент с которым надо разобраться. В большинстве случаев вы знаете, что эта проблема решается 100%, но не знаете как. Если переключиться на ее решение, вы собьетесь с фокуса текущей проблемы, потом для того, чтоб вернуться придется потратить время, переключение контекста никогда не было бесплатной операцией. Эта идея так же распространяется на детали реализации. Предположим вам надо написать функцию которая читает какие-то данные из базы и записывает их в файл. Вот то и есть вашим контекстом. Решите эту проблему потом решайте остальные (тоесть чтение из базы и запись в файл). Изначально мы пишем следующее:
var data = Read(); Write(data);
и генерируем 2 заглушки для Read и Write, благо вижуал студия имеет магическую комбинацию клавиш alt+shift+f10, которую я прожимаю чаще всего (перебиндить ее на f1, просто f1 вместо поиска, мешает только то что это надо делать у всех). Что нам дает такой подход. Во-первых, мы пишем быстрее ибо остаемся в контексте. Во вторых мы пишем лучше ибо в один момент решаем одну задачу, да, ошибок будет меньше. В третьих мы получаем лучше код, он изначально формируется правильно. Функции называются правильно и по контексту, они получаются маленькие и простые. На мой взгляд это самая важная практика из всех перечисленных здесь.
Чувствуй запах
Как писал Фаулер в своем бессмертном произведении, у кода есть запах. Не буду сильно повторяться, скажу кратко. Если вы ощущаете, что с кодом что-то не так, подумайте как его улучшить. Такое чувство возникает как правило с опытом, однако если вы все время будете анализировать то, что пишете, после написания, оно у вас будет развиваться намного быстрее. Однако помните, идеала нет!
Лучше безобразно но единообразно
Выработайте свою систему именования переменных, функций и тп. старайтесь ее максимально придерживаться. Я вот например возвращаемое значение функции всегда называю result, может это не правильно и не отражает смысл, отсылка во времена делфи, но я так делаю и мне это нравится, мне так удобно. Также я всегда использую var никогда не использую явное типизирование (ну только когда выхода нет). Я так же стремлюсь всегда давать очень короткие имена переменным i,d,v,k для меня не проблема, ибо функции маленькие все понятно из контекста. Зачем писать currentNode если можно написать просто n и при это все равно все ясно? Более того, длинные имена переменных часто только усложняю изложение. Про стандарты кодирования я тут молчу это другая тема, их просто надо придерживаться.
Что? Где? Когда?
Задавайте себе больше вопросов по тому коду который вы пишете. Обрабатываются ли исключения? Правильно ли сделано управление ресурсами? Очищаются ли у вас кеши в нужный момент? Все ли хорошо с потокобезопасностью? Правильно ли вы используете библиотеки? В том ли месте находится функция которую вы пишете? Существует очень много вопросов которые стоит рассмотреть даже после того как код уже работает. Надо задаваться этими вопросами постоянно, тогда это войдет в привычку и все это будет делаться уже автоматом.
Будьте проще и люди к вам потянутся
Шаблоны проектирования, иерархии классов, элементы функционального программирования это все замечательные вещи. Однако стоит по возможности стараться все делать как можно проще. Чем проще код, тем он понятнее и тем легче его сопровождать. Глубокие иерархии классов очень сложно поддерживать и понимать. Зачастую наследования вообще стоит избегать, старайтесь заменять его реализацией интерфейсов. Шаблоны проектирования тоже дают великолепные решения, но подумайте, может стоит все сделать просто? Возможно оно так будет понятнее? Зачастую так оно и есть.
И на последок еще несколько замечаний
— Если вы дебажите свой код, который только что написали, что-то пошло не так.
— Стоит реже компилировать свой код, вообще стоит больше писать меньше собирать. Если вы конечно активно используете юнит тесты, то этот пункт в принципе отпадает, там и правда лучше чаще собирать и запускать тесты. Однако все равно не стоит это делать слишком уж часто.
— Изучите все возможности которые дает среда разработки, выучите горячие клавиши и используйте их, это очень сильно экономит время. Однако не советую сильно настраивать под себя среду, будет очень сложно если придется помогать коллеге за его компьютером.
Я здесь умышленно не привожу примеры кода, сейчас я пишу на C# (как пытливый читатель уже наверно догадался), но дело в том, что не существует принципиальных отличий в написании кода на PHP, C++, Delphi, C# и тп. даже на сильно отличающихся языках (например функциональных).
Хочу отметить, что простое прочтение каких-то правил и советов ничего не дает, надо отрабатывать. И вот это последняя мысль которую я хочу выразить. Не пишете просто код, всегда отрабатывайте и улучшайте свои навыки. “Сейчас просто напишу, а дома на кошках потренируюсь” ничего вам не даст совершенно. Можно было бы еще продолжить и расширить мой список, но я считаю изложенные моменты основными.
5 способов быстрее научиться программировать
Как быстро научиться программировать: 5 простых шагов, которые помогут вам начать изучение профессии программиста. Изучайте и запускайте примеры кода, используйте отладчик, пишите свой код и не бойтесь спрашивать.
Изучение программирования — не то, чем можно заниматься между делом. Но не нужно тратить всю жизнь, чтобы понять основы. Есть множество способов облегчить себе обучение.
Нередко бывает, что новички начинают учиться, уже зная что-то о программировании. Сначала всё идёт хорошо, но по мере дальнейшего изучения начинаются проблемы. Почему? Новички быстро пробегают вступительную часть, думая, что и так всё знают, но на деле это бывает редко. Они знают часть материала, но этого недостаточно, чтобы хорошо понять основы.
В то же время нельзя прекращать развиваться. Вы можете двигаться медленно или быстро, но не пропускайте ни одну тему. Осваивая больше материалов, вы создаёте себе фундамент для будущего.
1. Изучайте примеры кода
Говоря о чтении, мы обычно подразумеваем чтение слов на странице, но программирование — это про чтение кода. Когда вы только учитесь программировать, вы должны изучать и пытаться понять каждый пример. Можно даже сперва читать и пытаться понять примеры кода, а уже потом читать текст. Это не всегда срабатывает, но зато учит смотреть код внимательно и вникать в каждую деталь.
2. Не просто читайте примеры кода — запускайте их!
Когда вы читаете обучающее руководство или учебник, легко посмотреть на пример и сказать: «Я понял, я понял. Да, в этом есть смысл». Конечно, вы могли понять его, но вы не знаете наверняка действительно ли вы поняли его правильно. Есть лишь один способ выяснить — сделать что-то с кодом.
Если вы до сих пор не сделали этого, установите среду разработки (IDE), которая поддерживает ваш язык программирования.
Затем перенесите пример в IDE — если вы набьёте его вместо того чтобы просто скопировать, вы действительно пройдётесь по нему от начала до конца. Ввод кода заставит вас уделять внимание деталям синтаксиса языка, например точкам с запятыми, которыми должна заканчиваться каждая строка.
Теперь скомпилируйте и запустите код. Убедитесь, что он делает именно то, что должен.
И наконец, измените его. Программа — самый легко изменяемый механизм на Земле. Вы можете экспериментировать и смотреть, что происходит. Изменения будут происходить мгновенно, без риска смерти или получения увечий. Самый простой способ изучить язык программирования — взять работающий код и изменить его.
3. Начните писать свой код как можно раньше
Как только вы что-то поймёте про язык — даже если от него у вас уже кружится голова — начните писать программы на нём. Иногда трудно найти идеи для программ. Это нормально, в самом начале вам не надо придумывать свою идею.
Вы можете также воспроизвести упражнения из руководства или книги, которую вы читаете, не заглядывая в примеры. Это не так легко, как кажется. Ещё эта техника работает хорошо, если вы слегка измените код из примеров.
Если вы не хотите думать о маленьких программах, а хотите сразу писать нечто большее, вроде игр, вам надо начинать с маленьких кусочков, которые вы затем сможете использовать для создания игры. Независимо от того, будете вы их использовать или нет, вы получите ценнейший опыт.
4. Научитесь использовать отладчик
Отладчик позволит вам двигаться по коду строка за строкой. Вы сможете наблюдать значения переменных и видеть, выполнилось ли условие.
Отладчик позволяет быстро ответить на вопросы о том, что делает код.
Первое время исправление ошибок с отладчиком будет занимать много времени. Но по мере того, как количество ошибок в вашем коде будет расти, отладчик начнёт экономить уйму вашего времени. А количество ошибок, поверьте, будет измеряться десятками.
Новички часто не желают использовать отладчик. На самом деле, они усложняют жизнь самим себе, тратя годы на исправление очень простых ошибок. Чем раньше вы изучите отладчик, тем раньше это вам воздастся.
5. Ищите больше источников
Если вы что-то не понимаете, в первую очередь посмотрите альтернативные объяснения — интернет полон информации о программировании. Мы все воспринимаем новую информацию по-разному: может быть, вам для понимания нужны картинки, а кому-то другому — подробные инструкции или множество книг с детальными объяснениями.
Но если это не работает, то лучший способ разобраться с проблемой — спросить кого-то другого. Однако, если вы скажете «я не понимаю, пожалуйста, объясни», то, скорее всего, получите в ответ ссылку на тот же текст, который вы не поняли. Вместо этого, своими словами перескажите, как вы поняли текст. Чем больше вопрос раскрывает ваши мысли, тем легче будет знающему эксперту ответить на него. Программисты иногда кажутся раздражительными при ответе на вопросы. Но причина скорее в том, что они хотят продвинуться в диалоге, а это требует усилий от обеих сторон. Если вы зададите умный, подробный вопрос, который продемонстрирует, что вы думаете, то получите хорошие результаты.
На основе статьи «5 Ways To Learn Programming Faster».
Как пишут код на разных этапах карьеры
Мы наткнулись на какую-то дурку на StackOverflow, что, мол, сначала ты пишешь код абы как, потом много комментируешь, потом обкладываешься формальными конструкциями, потом ещё что-то, а на вершине профессионального роста — снова абы как. Мы хихикнули, а потом задумались — а как оно на самом деле. И вот что получилось.
Самое начало: лишь бы работало
Когда человек только начинает осваивать кодинг, его главный принцип звучит так: лишь бы работало и запустилось. Из-за этого в ход идёт всё подряд:
- готовые фрагменты кода со StackOverflow;
- примеры из материалов и учебников;
- избыточные и громоздкие конструкции;
- переменные, которые объявляются, но так и не используются.
�� Код или выглядит предельно просто и «в лоб», или состоит из безумных конструкций и решений, разобраться в которых крайне сложно.
На этом этапе полезно изучать лучшие практики программирования, подключать готовые библиотеки и применять проверенные паттерны и алгоритмы. Так разработчик переходит на следующий этап.
Правильный код
Спустя некоторое время программист набивает руку и начинает писать «правильный код»:
- использовать общепринятое форматирование;
- оставлять самому себе комментарии, чтобы вспомнить, почему тут сделано именно так;
- использовать встроенные возможности языка, а не изобретать, например, свой способ работы с классами или массивами;
- выбирать названия всех переменных, классов и методов в едином стиле, так, как принято в этом языке программирования.
Обычно на этом этапе программисту кажется, что он полностью разобрался в языке и может использовать все его возможности. Но тут он узнаёт про библиотеки и фреймворки.
�� Код выглядит как образец программирования: идеальные комментарии, всё логично и стройно. Нет ни одного решения, которое бы вызывало вопросы «А почему это сделано именно так».
Библиотеки и фреймворки
Поначалу программисту достаточно встроенных возможностей языка, но со временем он понимает, что часть задач можно решить быстрее и проще с помощью внешних библиотек. И тут начинается:
- поиск самой лучшей библиотеки и фреймворка;
- куски чужого кода в своей программе, скопированные из блога разработчика фреймворка;
- переписывание старых программ под новый фреймворк.
Если увлечься, дело доходит до того, что программист не берётся за решение никакой задачи, пока не найдёт для неё специальный фреймворк. Если это JavaScript-программист, то на этой стадии он может зависнуть на годы или навсегда — новые js-фреймворки выходят каждую неделю.
�� Код выглядит как код хакера из фильмов: сложные конструкции, понятные только избранным; неочевидные решения, которые продиктованы логикой фреймворка; очень много команд из внешних библиотек.
Совместимость, комьюнити и внешние сервисы
К этому времени у разработчика уже много опыта:
- он умеет решить большинство задач, которые возникают в разработке;
- знает, что и как применить, чтобы получить нужный результат;
- его код работает сразу и почти без ошибок.
Когда программист выходит на такой уровень, он понимает, что личная и самостоятельная разработка — это хорошо, но для серьёзных продуктов нужна поддержка со стороны, совместимость с другими сервисами и умение работать с API. В код добавляются функции для поддержки всех этих возможностей, он разрастается, и разобраться в нём становится очень сложно. Также код обрастает разными манифестами, декларациями, лицензиями, открытой и закрытой частями и поддержкой внешних сервисов.
�� Разобраться в этом коде сможет только программист с такой же квалификацией. Остальные смотрят, кивают и идут дальше заниматься своими делами. Поддерживать этот код могут 1–2 человека в компании.
15 лет практики: лишь бы работало
Спустя годы непрерывной практики программист понимает, что всё это суета и тлен, а задачи можно решать намного проще. Он настолько в своём познании преисполнился, что ему уже не нужно думать о совместимости, библиотеках или названиях переменных. Всё, что делает программист на этом этапе, — просто пишет рабочий код так, как ему удобно. При этом в его коде можно встретить:
- фрагменты кода из StackOverflow, потому что так быстрее;
- переменные из одной буквы, потому что так проще;
- избыточные команды, потому что так быстрее, а при компиляции компьютер всё равно это оптимизирует;
- один-два комментария на весь код, потому что остальное и так понятно, чего тут ещё объяснять?
�� Код на этом последнем этапе выглядит почти так же, как код на первом этапе, за одним исключением: в отличие от новичка, этому программисту мир абсолютно понятен. Он здесь ищет только одного — покоя, умиротворения и вот этой гармонии от слияния с бесконечно вечным, от созерцания этого великого фрактального подобия и от вот этого замечательного всеединства существа.
Уроки Cи
Представляем курс по изучению языка программирования Си. Си является одним из самых популярных языков в программировании и за его изучение обычно берутся ещё в школе или университете.
Видеоурок
Полезные ссылки:
- Программа Code Blocks ;
- Программа Visual Studio .
Информация по языку Си
Сам по себе язык программирования Си многие считают устаревшим языком программирования. Несмотря на это, язык плотно и уже очень долго находиться в списке как один из наиболее популярных языков программирования в мире. И скажем сразу, язык из этого списка в ближайшее время никуда не уйдет.
Си язык программирования используется многими компаниями уже более 30 лет подряд. Си язык быстрее по скорости выполнения нежели все его конкуренты. На сегодняшний день ему конкуренцию составляет язык Golang, но язык программирования Си все равно быстрее даже его современного аналога. Такое происходит из-за процесса выполнения кода. Он выполняется практически на уровне процессора.
Сегодня язык Си используют не многие компании в качестве главного языка для создания какого-либо проекта. Это обусловлено тем, что существуют такие языки программирования, как: С++ , Java , C# и тому подобные, которые выполнять роль нужного языка куда лучше чем Си.
Язык Си реально стар, ведь появился еще в 1972 году. Как понимаете, разрабатывался он с учётом компьютеров того времени, а они были как современный калькулятор по функционалу. Если бы не постоянная поддержка языка, то язык давным давно бы умер и все бы о нём забыли. За счёт того что он постоянно развивается, то даже сейчас он не утратил сил и на нём вполне можно разрабатывать. Язык низкоуровневый, а значит имеет хороший отклик и быстрое выполнение.
Что интересно, то на основе языка Си создано огромное множество других языков. Существует термин: «Си-подобные языки программирования ». Этим определением обозначают языки программирования, что построены на базе Си языка. Это такие, как: C++, C#, D, Java, Objective C, PHP, Perl, Scala и еще сотни других.
Кстати, книг на темы: « с для чайников », « основы с », «С и с нуля » выпущено больше, нежели аналогичных книг по другим языкам вместе взято.
Так почему же язык всё равно популярен?
Язык был и будет популярным, ведь на его основе на сегодняшний день построено огромное множество проектов, которые требуют постоянной поддержки и соответсвенно специалистов. Кроме того, язык является хорошим языком и написав программу на нём вы получаете достаточно быструю в плане выполнения программу. Ну и конечно же, язык Си для многих является словно родителем других языков и многие, включая университеты, предпочитают начинать путь изучения именно с этого языка.
Это не глупо, ведь язык действительно повлиял на очень многие современные языки программирования и его принципы можно встретить практически во всех сегодняшних новомодных языках.
В общем, язык стоит изучить хотя бы по той причине, что он даёт базовое фундаментальное понимание принципов работы компьютера и языков программирования. В дальнейшем если вы захотите перейти на С++ , C# , Java или даже Python , вы всё равно найдёте очень много схожего и изучение следующего языка вам явно будет даваться проще. Поэтому если вы еще не решились изучать или нет Си, но при этом ещё с программированием не сталкивались, то наш вам совет — учите Си и данный курс вам как раз предоставит всё необходимое чтобы его изучить.
Эти знания вам ни раз пригодятся, а главное как гордо можно будет заявить: «Я начинал изучение еще с языка Си», — красота.
Установка необходимого
Для работы с языком потребуется установить среду разработки, в которой мы сможем писать код и выполнять его. Программ, которые подходят под эти нужды очень много, выделим несколько из них:
- Visual Studio ;
- Code::Blocks ;
- Xcode (только ПК Мак);
- Онлайн компилятор (представлен ниже на этой странице).
План курса
За курс мы познакомимся с языком программирования Си. Мы изучим язык Си с нуля для новичков. Вами будет изучен базовый синтаксис языка, а также некоторые сложные конструкции, по типу: структур данных, работы с файлами, работы с функциями и многое другое.
Программирование на c для начинающих изучается во многих университетах, поэтому в курсе будет много тонкостей связанных с основами Си.
К концу курса у вас будет достаточно знаний, чтобы создавать консольные проекты на языке Си.
Основной файл
#include // #include int main() < printf("Hello, World!\n"); // system("pause"); return 0; >