Комментарий

Комментарий — часть исходного кода, не влияющая на выполнение программы, однако несущая смысловую нагрузку для программиста. То же: comment.

Комментарии просто игнорируются компилятором, поэтому этот участок кода никак не влияет на работу программы.

В Эрланге комментарий в строке начинается со знака процента. Всё, что следует за этим знаком, начиная с него самого, компилятор игнорирует. Пример:

A = 2*2, % Находим, чему равно дважды два.

Многострочных комментариев в Эрланге нет. Если комментарий распространяется на несколько строк, каждую надо начать со знака процента.

Многие программисты придерживаются следующего правила:

Предназначение всего модуля комментируют с помощью тройного знака: %%%. Обычно это строка в самом начале файла.
Предназначение функции комментируют с помощью двойного знака: %%. Обычно это перед определением функции.
Одинарный знак % используется для локальных комментариев.

Пример:

%%% Модуль содержит арифметические функции.
-module(arithmetic).
-export([plus/2, minus/2]).

%% Сложение.
plus(A,B) ->
    % Сейчас полученные аргументы будут сложены.
    A + B.

%% Вычитание.
minus(A,B) ->
    A - B. % Второй аргумент вычитается из первого.

Предназначение модуля и функции можно описать с помощью атрибутов -moduledoc и -doc. Чтобы не дублировать пояснения, от соответствующих комментариев можно отказаться.

-module(arithmetic).
-export([plus/2, minus/2]).
-moduledoc "Модуль содержит арифметические функции.".

-doc "Сложение.".
plus(A,B) ->
    % Сейчас полученные аргументы будут сложены.
    A + B.

-doc "Вычитание.".
minus(A,B) ->
    A - B. % Второй аргумент вычитается из первого.

Взамен после компиляции мы получаем справку по модулю и его функциям.

1> h(arithmetic).

    arithmetic

  Модуль содержит арифметические функции.
ok
2> h(arithmetic, plus).

  plus(A, B)

  Сложение.
ok
3> h(arithmetic, minus).

  minus(A, B)

  Вычитание.
ok

Программисты часто используют комментарии для сокрытия от компилятора спорного кода.

% B = A*A*A,
B = math:pow(A,3),

Мы ещё не решили, как лучше, поэтому один вариант закомментировали.