Этому меня никогда не учили. Я видел много разных типов авторских стилей. Я кодирую в основном на Java и Python. Мне было интересно, был ли стандартный стиль авторинга или все вольным стилем. Также, если вы ответите, не могли бы вы присоединить стиль, который вы используете, к авторам файлов, которые вы создаете дома или на работе.
Я обычно просто иду
@author garbagecollector
@company garbage inc.
programming-practices
dustyprogrammer
источник
источник
Ответы:
Не совсем уверен, что вы спрашиваете, однако я использую очень строгий стиль:
Стиль вдохновлен ассемблерами.
Я помещаю это в верхнюю часть страниц, которые мне нужны, чтобы «Автор», независимо от того, является ли это классом, текстовым файлом или хранимой процедурой SQL и т. Д.
источник
Почему ты? это работа системы управления версиями и "винить" :)
источник
Мы не занимаемся авторингом в моей компании. Вместо этого мы позволяем нашему управлению версиями справиться с этим.
Каждый раз, когда вы регистрируетесь, он добавляет ваше имя пользователя в список изменений. Если что-то сломано, кто-то может вернуться и посмотреть историю изменений, чтобы увидеть, что изменилось, когда и кто это сделал. Также аккуратно смотреть на график ревизий, чтобы увидеть, как файл развивался с течением времени, кто к нему прикасался, какие проекты из него ветвились.
Проблема, которую я вижу при добавлении тега автора в класс, состоит в том, что со временем вполне вероятно, что над этим классом будет работать более одного разработчика. Обновления и тому подобное. Это дополнительный шаг для обновления этого комментария автора, а дополнительные мелкие шаги часто забываются. Таким образом, он быстро устареет.
источник
Я не делаю этого вообще. Я думаю, что на работе у нас есть какой-то шаблон, который вставляется в файлы с названием компании и ИД пользователя, который последний раз изменял файл, но я никогда не обращал на это внимания.
В общем, я не думаю, что действительно важно, как ты это делаешь. Если вы хотите сделать печать на своих файлах, просто выберите подходящий стиль и используйте его.
источник
JavaDoc очень стандартен в сообществе Java:
http://download.oracle.com/javase/1.3/docs/tooldocs/win32/javadoc.html#@author
источник
Я думаю, что лучше оставить систему контроля версий.
источник
Мне нравится функция обвинения в GIT. Вы можете видеть, кто является автором каждого куска / строки кода. Не просто файл.
источник
Если вы работаете над большим проектом со многими участниками, аннотирование каждого файла списком авторов просто не работает. Что вы делаете со списком авторов, когда делите файл на несколько файлов меньшего размера? Вы сохраняете оригинальное имя автора, если полностью переписали код? Вы добавляете свое имя в список авторов, когда исправляете опечатку в комментарии?
Эти вопросы лучше оставить для системы контроля версий.
Но я не совсем против списка авторов. Ведение списка авторов для всего проекта имеет смысл. Если это проект с одним файлом, храните его в этом же файле. Если это более крупный проект, сохраните его в README или в исходном файле верхнего уровня (он же main.c). Но не повторяйте себя, перечисляя авторов в каждом файле.
источник
Мы отслеживаем использование системы контроля версий или путем размещения
@author
в коде. Еще один способ сделать это - сказать, что некоторые люди были авторами целых модулей или всей программы. Это побуждает людей воспринимать себя как часть команды, а не как шестеренку в машине, которая отвечает за ровно X функций или строк кода.источник
Я использую комментарии в стиле Doxygen (или иногда KernelDoc) почти для всего. В основном я работаю на C и PHP, где Doxygen довольно популярен.
В большинстве случаев полезно по крайней мере включить следующую информацию:
Это должно помочь любому, кто работает с файлом, знать, что у него есть, что он может с ним сделать и к кому он может обратиться за помощью, если он в этом нуждается. Это также говорит им, если они смотрят на что-то 10 лет.
источник
Лично я этого не делаю, потому что это дополнительная документация, которая, как говорили другие, находится в управлении версиями. Но если бы я собирался сделать какой-то фрагмент кода кунг-фу, я, вероятно, был бы готов пойти на то, что моя IDE была способна автоматически генерировать.
Например, используя Delphi 7 с этими полезными установленными CNTools, я печатаю
и выходит
тогда я печатаю
и выходит
Я думаю, что это соответствует чему-то, что может подхватить какая-то сторонняя утилита, но что касается меня - у меня есть стандарт, который мне даже не нужно было придумывать и портить.
источник