Так что будет правильным комментарием, если я не помещу имена атрибутов в файл .h?
/**
* Grid constructor
* @param width
* @param height
*/
Grid(int, int);
/**
* Function that displays grid on std output
*/
void displayCells(void) const;
/**
* Tells if cell is in grid
* @param cell x
* @param cell y
* @return true if is in the grid, otherwise false
*/
bool isCellInGrid(int, int) const;
Я хочу сделать C ++ эквивалентом JavaDoc в моем заголовочном файле.
У меня есть члены функции, которые выглядят так:
Так что будет правильным комментарием, если я не помещу имена атрибутов в файл .h?
Решение
Задача ещё не решена.
Другие решения
Других решений пока нет …