Как оформлять решение учебных задач на PHP -- подробности
Primary tabs
Ещё раз поговорим о том, как оформлять решённые задачи (в частности, эти задачи по php).
- Для начала ознакомьтесь с возможностями оформления заметок на данном сайте (см. видео) а также с тем, как подсвечивать код (синтаксис языка программирования).
- Каждая задача оформляется как отдельная тема в этом разделе (PHP) -- т.е. на каждую задачу создаём отдельную тему.
Также тут стоит отметить, что публиковать задачу (и уведомлять тех, кто их проверяет) стоит сразу после решения -- это важно потому, что во первых так сразу видно как идёт процесс, а во-вторых, это позволяет не писать одни и те же замечания под несколькими задачами, что очень удобно для проверяющих.Ждать пока проверят предыдущую опубликованную задачу, если вы уже решили следующую -- не надо, также выкладывайте её отдельной темой и дайте знать проверяющим.
- При оформлении кода задачи следуйте правилам именования сущностей и также правилам форматирования кода (обратите внимание на пробелы между операторами и пробелы в других случаях, а также на то когда строка переносится, а когда нет.)
Следование этим правилам, построенным на очень популярном стандарте, позволит вам писать более "понятный" для других программистов код. - Обратите внимание на то как оформлен код товарищами уже эти задачи решавшими:
Необходимо чтобы на странице решения было:- Условие задачи: либо в комментариях к коду -- как тут (что удобно самому решающему, ведь он может видеть это условие во время решения задачи, например в онлайн-интерпретаторе), либо просто цитатой как тут.
- Обратная ссылка на список задач (как, например, там).
- В заголовке помимо номера задачи желательно указывать основной смысл того, что происходит (это не обязательно должна быть цитата из условие -- можно что-то более краткое и ёмкое например)
- Внизу при создании заметки есть поле с ключевыми словами - -желательно удалять стандартные и через запятую перечислить те ключевые слова и/или словосочетания, которые, как вам кажется, дополнительно поясняют что происходит (например, как в решении этой задачи - там это "последовательность, Фибоначи, elseif").
Это слова, по которым будет происходить поиск с помощью поисковой строки сайта или внешней поисковой системы. Поэтому среди них стоит указать то, что может теоретически заинтересовать других людей в данной заметке. То есть, что-то более конкретное, информативное, например, "php с нуля", "решние алгоритмических задач php", "php rand". Представьте себя на месте ищущего. Ответом на какой запрос может стать эта статья?
- Log in to post comments
- 3930 reads