C++ : Оформление кода

Теперь, когда мы уже научились писать простые программы, можно немного поговорить о том, как их писать.

Код программы следует оформлять определенным образом, чтобы он был достаточно понятным и простым в поддержке. Специальные наборы правил — стандарты — описывают различные аспекты написания кода. Конкретно в C++ самым распространенным стандартом является стандарт от Google.

В любом языке программирования существуют утилиты — так называемые линтеры. Они проверяют код на соответствие стандартам, и могут сами поправить небольшие отклонения от стандарта. В мире C++ есть два распространенных линтера cpplint и cppcheck.

Cpplint следует стандарту от Google.

Взгляните на пример:

int main () {

}

cpplint будет «ругаться» на нарушение:

./modules/20-arithmetics/70-codestyle/main.cpp:3: Extra space before ( in function call [whitespace/parens] [4]

./modules/20-arithmetics/70-codestyle/main.cpp:3 – это путь к файлу и номер строки в которой было нарушение. Далее идет текст сообщения и [whitespace/parens] – правило, которое было нарушено. Это правило требует отсутствие пробелов между именем функции и параметрами. Оно не влияет на результат, но помогает писать код понятнее и проще для восприятия. Код с учетом этого правила выглядит так:

int main() {

}

Теперь линтер ругаться не будет.

Какой мы делаем вывод? Линтер это хорошо, но он не отменяет самостоятельного анализа и упрощения чтения кода.

Сейчас сайт не будет проверять ваш код линтером, но в ваших будущих практиках на Хекслете и в реальной разработке линтер будет работать и сообщать вам о нарушениях.

Задание

Выведите на экран результат следующего вычисления: «разность между суммой пяти и двух и произведением трёх и семи». Сравните получившийся результат с решением учителя с точки зрения оформления кода.

Как с вами связаться? 🙃

Команда проекта находится в телеграм-сообществе по ссылке https://ttttt.me/HexletLearningBot. Там можно задать любой вопрос и повлиять на проект

Упражнение не проходит проверку — что делать? 😶

Если вы зашли в тупик, то самое время поговорить с нашим асситентом Тота во вкладке "Обсуждение". Как правильно задать вопрос:

В моей среде код работает, а здесь нет 🤨

Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.

Мой код отличается от решения учителя 🤔

Это нормально 🙆, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи. В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.

Прочитал урок — ничего не понятно 🙄

Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в обратной связи нашего сообщества

Нашли ошибку? Есть что добавить? Пулреквесты приветствуются

Привет! Я Тота и моя задача помочь в обучении. Чтобы активировать меня, нужно зарегистрироваться или залогиниться, если у вас уже есть аккаунт

Loading...

Ваше упражнение проверяется по этим тестам

1#include "test_helper.h"
2
3TEST_CASE("testing solution") {
4  std::string expected = "-14\n";
5  std::string actual = get_output(sizeof(expected));
6
7  CHECK(actual == expected);
8}
9

Решение учителя откроется через:

20:00
waiting_clock