Псевдокод — он вам нужен?

Псевдокод — это в основном способ организации мыслей перед тем, как вы напишете сегмент кода или, возможно, целую функцию с упрощенным языком, который обрисовывает код в общих чертах, не записывая его. Хотя часто лучший код читается без контекста из-за соответствующих имен переменных и потока, если сложность оправдана, что-то неясно, или это первый экземпляр фрагмента кода, имеющий псевдокод в комментарии. Кроме того, такая организация заранее дает лучшие и более быстрые результаты.

Простой пример псевдокода на C# внутри комментариев.

Вещи, которые делают хороший псевдокод:

  • Просто и читабельно
  • Заглавная буква первого слова.
  • Использование ключевых слов, таких как FOR, RETURN, END IF, INCREMENT и т. д.
  • Старайтесь избегать ссылок на конкретные языки.
  • Избегайте слишком большого количества конкретных именованных переменных.

Даже мои примеры можно улучшить. Если в игре, которая является 2D Space Shooter, где вы пишете функцию для описания движения, вам следует избегать ссылок на корабль или игру, чтобы обеспечить абстракцию, что, на мой взгляд, является самой сложной задачей. Исключением является, если вы ссылаетесь на именованный класс или функцию в своем коде. Так нужен ли вам псевдокод? Возможно, особенно если вы обдумываете вопрос.