Существуют ли стандартные форматы комментариев в коде?

Question

Мне интересно, есть ли у людей стандартный формат комментариев в их коде. Не такие вещи, как комментарии xml для метода или класса, а комментарии внутри метода.

---

Смотри также:

Существует ли стандарт (например, phpdoc или строка документации python) для комментирования кода C #?

Answer 1

Если вы параноик и не используете или не доверяете контролю источника, вы можете сделать это

// Initials-YYMMDD-fixNo-Start
dosomething();
// Initials-YYMMDD-fixNo-Finish

Это чертовски большой беспорядок, но дает вам возможность откатить изменения.

Но я бы предложил использовать контроль исходного кода

Answer 2

(* Modula-2 comments go like this *)

Answer 3

- я обычно пишу такие комментарии

в SQL

Answer 4

Я удивлен, что не больше людей рекомендуют доксиген. Это хороший способ документирования кода с побочным эффектом, заключающимся в том, что он может автоматически генерировать документацию по API html + pdf в конце дня.

Answer 5

Я предпочитаю комментировать этот способ для функции

/**
 * Activates user if not already activated
 * @param POST string verificationCode
 * @param POST string key
 * @return true on success, false on failure
 * @author RN Kushwaha <rn.kuswaha@gmail.com>
 * @since v1.0 <date: 10th June 2015>
 */

открытая функция activUserAccount () {

// код здесь

}

Я использую однострочный комментарий для описания кода, например

//check if verificationCode exists in any row of user table
code here

Answer 6

Мне нравится делать такие вещи:

/************
*  Comment  *
************/

Таким образом, мне приходится тратить время на переформатирование всего блока каждый раз, когда я добавляю / удаляю текст