Комментирование в C ++

Question

Я добавляю комментарии к программе на С ++.Допустим, у нас есть что-то вроде этого:

string House:: getName(int &size){

return name;
}

В Java, когда вы пишете комментарии выше, рядом со звездочками, вы называете их так:

/*
* @param size It passes the number of rooms.
  @return name. It returns name of the house
*/

В каком формате это делается вC ++?

Answer 1

Вы имеете в виду Javadoc , и вы можете использовать тот же стиль комментариев в C ++ с теми же редакторами и внешними инструментами.

Нет никакого стандарта C ++ для документов комментариев.

Answer 2

Если вы извлекаете документацию из кода, вам необходимо следовать соответствующему формату комментариев. Например, мы используем DOxygen, поэтому мы должны следовать правилам Doxygen.

Если вы не собираетесь извлекать комментарии для документации, тогда применяются простые хорошие методы кодирования.

Answer 3

Особых правил нет.Комментарии - это комментарии, они игнорируются и выбрасываются, так что вы можете формировать их по своему усмотрению.

Если вы хотите использовать программу, которая интерпретирует комментарии, например, doxygen, то вам нужно посмотреть нассылка на эту программу.

Answer 4

Если вы используете Visual Studio, здесь - это спецификация для комментариев.