Нет реального соглашения, которое использует каждый программист, при условии, что вы предоставляете всю информацию и поддерживаете формат в соответствии со всем вашим кодом.
Звучит так, как будто вы используете какой-то формат doxygen, однако я довольноуверен, что он не принимает данные в начале файлов, используя'@'.
. Лично я бы удалил '@', чтобы сделать его более понятным для программиста по просмотру, но это только я.Если вам действительно нужно позже отформатировать его, чтобы он соответствовал какой-либо другой программе создания документации, то, если вы делаете , что-то придерживаетесь, это будет просто написать программу, которая преобразует ваш исходный код в требуемый формат.Я почти уверен, что многие из этих программ можно изменить, чтобы изменить формат , который они также используют.
Некоторые люди ставят лицензию на все свои файлы кода, но лично я сохраняю свои проекты свободнымии используйте автоматическую программу, чтобы заполнить ее до того, как я ее выпущу.
Итак, окончательный ответ, используйте что-то ясное и постоянное для вас.