Как оформлять код, комментарии и документацию. (рекомендации)

Сюда я выпишу некоторые рекомендации по оформлению (со временем будет пополняться).

  1. Когда пишете текст об алгоритме и "говорите" о переменных старайтесь как-то выделить их - в PHP есть для этого "родной способ" с символом американской валюты - так используйте его и в обычной письменной речи - не только в коде, например:
    ...когда мы используем переменную $a в таком контексте, мы должны....

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

  2. Когда вы упоминаете имя функции - ставьте после него круглые скобки (справедливо для большинства языков), например:
    ...фунцкию get_all_vals() следует исправить!

Key Words for FKN + antitotal forum (CS VSU):

fgh's picture

Прочитал . )))