Изменения

Перейти к: навигация, поиск

Участник:Shersh/Оформление

606 байт добавлено, 21:19, 23 января 2014
Псевдокод: зелёный цвет, function
* Старайтесь называть переменные осмысленно, когда это возможно (s = a {{---}} плохо, sz = N {{---}} уже получше, size = newSize {{---}} идеально)
* Дополнение к концепции Python-style (надо понимать, что фигурные скобки, лишние круглые скобки, двоеточия после условий (хотя после главной функции можно) и многое другое {{---}} всё сделано для того, чтобы написать компилятор было проще, а программы компилировались быстрей, поэтому в псевдокоде надо стараться избегать всяких особенностей конкретного языка программирования, чтобы повысить читаемость кода)
** Операторы, ключевые слова, название самой глобальной функции, примитивные типы данных оборачивать в тройные кавычки ('''for''', '''if''', '''return''', '''and''', '''pushFront''', '''int''' и другие)
*** '''void''' _НЕ_ писать, если функция возращает ''ничего'', тип указывается, только если он разумный
**** Хотя, тип можно вообще не указывать и использовать динамическую типизацию
*** TODO: '''function'''
** Использовать словесное обозначение логических операций ('''and''', '''or''', '''xor''', '''not''' вместо &&, ||, !)
*** Вместо побитового '''xor'''-а ^ (крышечка) лучше писать <tex> \bigoplus </tex> (ниже о том, зачем это нужно)
*** len(queue), len(array) не писать {{---}} лишние скобки мешают читаемости
*** TODO: надо ли заменять isEmpty на <tex> == \varnothing </tex> ?
* Комментарии можно писать как через #, так и через //, так же можно и через /**/, но последний оформлять в javadoc стиле. Главное, придерживаться одного выбранного формата в рамках конспекта. Ещё очень наглядно обозначать комментарии зелёным цветом: <font color=green> // например, вот так </font>
* Случаи использования tex в псевдокоде:
** <tex> \varnothing, \emptyset </tex> вместо null

Навигация