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

Материал из Викиконспекты
Перейти к: навигация, поиск
(конспект создан; два пункта - tex & псевдокод)
 
м
Строка 1: Строка 1:
Основные правила написаны [[Обсуждение:Дискретная математика и алгоритмы | здесь]].
+
Основные правила написаны [[Обсуждение:Дискретная математика и алгоритмы | здесь]] и [[Участник:Kirelagin/Оформление | здесь]].
  
 
Далее приводится дополнительный список требований (что подразумевается, явно не написано, всякие уточнения, красивости, сборка из правил оформления других участников) который поможет сделать вики-конспекты красивее, лучше, понятнее.
 
Далее приводится дополнительный список требований (что подразумевается, явно не написано, всякие уточнения, красивости, сборка из правил оформления других участников) который поможет сделать вики-конспекты красивее, лучше, понятнее.
  
 
== Tex ==
 
== Tex ==
* Переменные и константы в тексте оборачивать в tex.
+
* Переменные и константы в тексте оборачивать в tex
 
** <tex> x, ~y, ~1 </tex> (сравни x, y, 1)
 
** <tex> x, ~y, ~1 </tex> (сравни x, y, 1)
 
* Классы чисел оборачивать в \mathbb  
 
* Классы чисел оборачивать в \mathbb  
Строка 14: Строка 14:
  
 
== Псевдокод ==
 
== Псевдокод ==
* Дополнение к концепции Python-style (надо понимать, что фигурные скобки, лишние круглые скобки, двоеточия после условий и многое другое {{---}} это всё сделано для того, чтобы написать компилятор было проще, а программы компилировались быстрей, поэтому в псевдокоде надо стараться избегать всяких особенностей конкретного языка программирования, чтобы повысить читаемость кода)  
+
* Дополнение к концепции Python-style (надо понимать, что фигурные скобки, лишние круглые скобки, двоеточия после условий и многое другое {{---}} всё сделано для того, чтобы написать компилятор было проще, а программы компилировались быстрей, поэтому в псевдокоде надо стараться избегать всяких особенностей конкретного языка программирования, чтобы повысить читаемость кода)  
 
** Операторы и ключевые слова оборачивать в тройные кавычки ('''for''', '''if''', '''return''', '''and''' и другие)
 
** Операторы и ключевые слова оборачивать в тройные кавычки ('''for''', '''if''', '''return''', '''and''' и другие)
 
** Использовать словесное обозначение логических операций ('''and''', '''or''', '''not''' вместо &&, ||, !)
 
** Использовать словесное обозначение логических операций ('''and''', '''or''', '''not''' вместо &&, ||, !)

Версия 18:52, 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 и другие)
    • Использовать словесное обозначение логических операций (and, or, not вместо &&, ||, !)
      • Вместо [math] \in [/math] лучше писать in.
      • Можно не как в python — not element in set, — а переставить операнды для повышения читаемости: element not in set.
  • Случаи использования tex в псевдокоде:
    • [math] \varnothing, \emptyset [/math] вместо null