Участник:Shersh/Оформление — различия между версиями

Материал из Викиконспекты
Перейти к: навигация, поиск
м (Добавлено неравно в #Псевдокод)
м (добавлены скобки в #Псевдокод)
Строка 22: Строка 22:
 
** <tex> \varnothing, \emptyset </tex> вместо null
 
** <tex> \varnothing, \emptyset </tex> вместо null
 
** <tex> \neq </tex> вместо !=
 
** <tex> \neq </tex> вместо !=
 +
** <tex> \langle, \rangle</tex> и другие виды скобок, если возвращается в функции какой-то сложный объект (например объект <tex> \mathrm{Pair} </tex>)

Версия 19:28, 11 ноября 2013

Основные правила написаны здесь и здесь.

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

Tex

  • Переменные и константы в тексте оборачивать в tex
    • [math] x, ~y, ~1 [/math] (сравни x, y, 1)
  • Классы чисел оборачивать в \mathbb
    • Натуральные числа [math] \mathbb{N} [/math] (сравни [math] N [/math])
  • Классы и функции оборачивать в \mathrm
    • Класс регулярных языков [math] \mathrm{REG} [/math] (сравни [math] REG [/math])
  • Вместо \mod использовать \bmod, когда применяется как бинарная операция
    • [math] x \mod y [/math] (сравни [math] x \bmod y [/math])

Псевдокод

  • Дополнение к концепции Python-style (надо понимать, что фигурные скобки, лишние круглые скобки, двоеточия после условий и многое другое — всё сделано для того, чтобы написать компилятор было проще, а программы компилировались быстрей, поэтому в псевдокоде надо стараться избегать всяких особенностей конкретного языка программирования, чтобы повысить читаемость кода)
    • Операторы, ключевые слова, название самой глобальной функции оборачивать в тройные кавычки (for, if, return, and, pushFront и другие)
    • Использовать словесное обозначение логических операций (and, or, not вместо &&, ||, !)
      • Вместо [math] \in [/math] лучше писать in.
      • Можно не как в python — not element in set, — а переставить операнды для повышения читаемости: element not in set.
  • Случаи использования tex в псевдокоде:
    • [math] \varnothing, \emptyset [/math] вместо null
    • [math] \neq [/math] вместо !=
    • [math] \langle, \rangle[/math] и другие виды скобок, если возвращается в функции какой-то сложный объект (например объект [math] \mathrm{Pair} [/math])