Форум Ардуино: Как правильно задать вопрос

Часть правил форума Ардуино про код - вариант на обсуждение(компиляция с других форумов)

Публикуйте весь свой код

Без кода - всего вашего кода - мы не сможем дать никаких ответов на ваши вопросы, кроме самых расплывчатых и, вероятно, бесполезных замечаний. Одна из неприятных вещей в программировании заключается в том, что ошибка в одном месте может привести к проблеме в совершенно другом, не связанном с первым, месте. Это кошмар для новичка, но часто не проблема для того, кто имеет опыт поиска таких ошибок. Именно по этой причине нам нужен весь ваш код, а не только часть с ошибкой или часть, которая, по вашему мнению, вызывает проблему.

Отформатируйте свой код

Прежде чем вставлять код в сообщение, войдите в меню Инструменты Ардуино ИДЕ и выберите Автоформат. Или наберите на клавиатуре Ctrl+T. Это позволит правильно отформатировать код и сделает его проще для восприятия.

Используйте теги кода

Код необходимо вставлять в тегах кода. Правильно вставленный код имеет подсветку синтаксиса и что особенно важно, номера строк и выглядит так:

char message[][4] = { "hi", "bye" };

void setup() {
  //Serial.begin() configures the serial port
  Serial.begin(9600);
}

void loop() {
  for (byte x = 0; x < 2; x++) {
    Serial.println(message[x]);
    delay(1000);
  }
}

Существует несколько способов добавления тегов кода:

  • Вставьте свой код в сообщение, выберите весь код и нажмите </> в верхней строке формы редактирования.
  • Добавьте в начале и конце кода по три обратных апострофа
  • В Arduino IDE в меню «Редактировать» есть кнопка «Копировать для форума», помещающая ваш код в буфер обмена с уже добавленными тегами кода, готовыми для вставки в сообщение

Минимальный воспроизводимый пример

На форуме установлено ограничение в 120 000 символов на сообщение, что означает, что вы не можете размещать программы более этого размера. Конечно, вы можете прикрепить файл .ino к своему сообщению или разместить ссылку на Гитхаб проект.
Однако учтите, что чем длиннее ваша программа, тем труднее кому-либо ее понять и найти в ней ошибку. По этой причине постарайтесь исключить из программы все лишнее и написать короткий код, иллюстрирующей проблему. Важно, тем не менее, чтобы этот пример был полноценной законченной программой, которую каждый мог бы открыть в ардуино ИДЕ и запустить. Помните, с короткой и простой для понимания программой у вас значительно больше шансов получить помощь, чем с длинной и сложной.

Сообщения об ошибках

Когда вы компилируете свой код, компилятор проверяет ваш скетч и генерирует сообщения об ошибках, чтобы указать на обнаруженные проблемы. Если это ваш случай, нам нужно увидеть сообщения об ошибках, поскольку сообщения компилятора дают ключ к разгадке проблемы. Если компиляция вашей программы завершилась с ошибкой, в правом нижнем углу окна IDE будет кнопка «Копировать сообщения об ошибках». Нажмите кнопку и вставьте результат в форум, не забыв добавить теги кода.
Помните, сообщения об ошибках бесполезны без полного кода программы, всегда вставляйте в вопрос и то и другое.

Типичные ошибки новичков при публикации кода

  • Публикация скриншота кода или сообщений об ошибках. Скриншот бесполезен, его невозможно вставить в IDE и протестировать. Ошибки на скриншоте часто очень сложно прочитать. Пожалуйста, публикуйте свой код и сообщения об ошибках, а не их изображения.

  • Публикация только той части кода, которая, по вашему мнению, содержит проблему. Часто реальная проблема находится не там, где компилятор выдает ошибку, или часто ошибка в одном месте проявляется как проблема в другом месте. Единственный способ разобраться в этом — увидеть весь код. Также имейте в виду, что некоторые ошибки вызывают множество сообщений компилятора. Если это произойдет, разберитесь с первым и посмотрите, не исчезнут ли остальные.

6 лайков

Закрепил!

3 лайка

а может имеет смысл создать менее свободную форму здачи вопроса с обязательными полями ?
если форум Программирование , то будет отдельние поля для кода или поле с ошибкой , причем оба поля могут принимать только текст как ввод.
если же не соответствует формату то отклонять размещение вопроса.
просто жалко начинать форум сначала , а через месяц будут опять вопросы с заголовком “Памагити ,не работает код”

всеж ,считаю ,направленность форума помогать тем кто хочет разобраться и посылать тех кто хамит . но порой из тех кто хамит бывает человек хочет разобраться, просто не сразу понял что от него надо вообще (большинство же приходит не науку познавать а какой то проэкт повторить или какую то одноразовую хотелку релализовать - “что за код такой ? как про него спрашивать ,хз” ).

Мне кажется, опубликованный текст не отвечает на вынесенный в заголовок вопрос, т.к. не объясняет, “Как правильно задать вопрос”, а уточняет, “что необходимо приложить к заданному вопросу”.

Сам же вопрос IMHO должен задаваться по схеме:

  1. Что хочется получить в результате.
  2. Что происходит на самом деле.
  3. Чем второе отличается от первого.

Ну а дальше - приложения: код и схема.

1 лайк

все верно.
В начале же есть оговорка - это только часть про код.

1 лайк

@Yana96
Эта ветка не предназаначена для вопросов про ардуино, тут обсуждаются правила общения на форуме.
Пожалуйста, создайте новую ветку в подходящем разделе, скорее всего это должна быть “Песочница” и разместите свой вопрос там.
А этот пост я попросил модератора удалить

2 лайка

33 записи были перенесены в новую тему: ИИ помощники в кодинге