Участник:Shersh/Оформление — различия между версиями
Shersh (обсуждение | вклад) м |
Shersh (обсуждение | вклад) м (Добавлено неравно в #Псевдокод) |
||
Строка 21: | Строка 21: | ||
* Случаи использования tex в псевдокоде: | * Случаи использования tex в псевдокоде: | ||
** <tex> \varnothing, \emptyset </tex> вместо null | ** <tex> \varnothing, \emptyset </tex> вместо null | ||
+ | ** <tex> \neq </tex> вместо != |
Версия 19:19, 11 ноября 2013
Основные правила написаны здесь и здесь.
Далее приводится дополнительный список требований (что подразумевается, явно не написано, всякие уточнения, красивости, сборка из правил оформления других участников) который поможет сделать вики-конспекты красивее, лучше, понятнее.
Tex
- Переменные и константы в тексте оборачивать в tex
- (сравни x, y, 1)
- Классы чисел оборачивать в \mathbb
- Натуральные числа (сравни )
- Классы и функции оборачивать в \mathrm
- Класс регулярных языков (сравни )
- Вместо \mod использовать \bmod, когда применяется как бинарная операция
- (сравни )
Псевдокод
- Дополнение к концепции Python-style (надо понимать, что фигурные скобки, лишние круглые скобки, двоеточия после условий и многое другое — всё сделано для того, чтобы написать компилятор было проще, а программы компилировались быстрей, поэтому в псевдокоде надо стараться избегать всяких особенностей конкретного языка программирования, чтобы повысить читаемость кода)
- Операторы, ключевые слова, название самой глобальной функции оборачивать в тройные кавычки (for, if, return, and, pushFront и другие)
- Использовать словесное обозначение логических операций (and, or, not вместо &&, ||, !)
- Вместо лучше писать in.
- Можно не как в python — not element in set, — а переставить операнды для повышения читаемости: element not in set.
- Случаи использования tex в псевдокоде:
- вместо null
- вместо !=