Jak śledzisz autorów kodu? [Zamknięte]

Tego nigdy mnie nie nauczono. Widziałem wiele różnych stylów tworzenia. Piszę głównie w Javie i Pythonie. Zastanawiałem się, czy istnieje standardowy styl autorskie, czy wszystko jest w stylu dowolnym. Również jeśli odpowiesz, czy nie masz nic przeciwko dołączeniu stylu, którego używasz do tworzenia plików, które tworzysz w domu lub w pracy.

Zwykle po prostu idę

@author garbagecollector
@company garbage inc.

Nie jestem do końca pewien, o co pytasz, ale używam bardzo surowego stylu:

;==========================================
; Title:  Author Style Sample
; Author: Darknite
; Date:   7 Jan 2011
;==========================================

Styl inspirowany jest programistami montażu.

Umieszczam to na górze stron, które muszę „Autor”, niezależnie od tego, czy jest to klasa, plik tekstowy, procedura przechowywana SQL itp.

Dlaczego miałbyś? to jest zadanie systemu kontroli wersji i „Winy” :)

W mojej firmie nie zajmujemy się pisaniem. Zamiast tego pozwalamy naszej kontroli wersji sobie z tym poradzić.

Przy każdym zameldowaniu dołącza nazwę użytkownika do listy zmian. Jeśli coś jest zepsute, ktoś może cofnąć się i spojrzeć na historię zmian, aby zobaczyć, co się zmieniło, kiedy i kto to zrobił. Dobrze jest również spojrzeć na wykres wersji, aby zobaczyć, jak plik ewoluował w czasie, kto go dotknął, jakie projekty się z niego rozgałęziły.

Problem, jaki widzę przy umieszczaniu znacznika autora w klasie, polega na tym, że z czasem jest prawdopodobne, że więcej niż jeden programista będzie pracował nad tą klasą. Aktualizacje i tym podobne. To dodatkowy krok, aby zaktualizować ten komentarz autora, a dodatkowe małe kroki są często zapominane. W ten sposób szybko staje się nieaktualny.

W ogóle tego nie robię. Myślę, że w pracy mamy szablon, który jest wstawiany do plików z nazwą firmy i identyfikatorem użytkownika osoby, która jako ostatnia zmodyfikowała plik, ale nigdy nie zwracam na to uwagi.

Ogólnie rzecz biorąc, nie sądzę, że to naprawdę ma znaczenie, jak to robisz. Jeśli chcesz automatycznie stemplować pliki, wybierz spójny styl i idź z nim.

JavaDoc jest bardzo standardem w społeczności Java:

http://download.oracle.com/javase/1.3/docs/tooldocs/win32/javadoc.html#@author

@author nazwa-tekst

Dodaje wpis „Autor” z podanym tekstem nazwa do wygenerowanych dokumentów, gdy używana jest opcja -author. Komentarz do dokumentu może zawierać wiele @authortagów. Możesz podać jedną nazwę dla @authortagu lub wiele nazw dla tagu. W pierwszym przypadku Javadoc wstawia przecinek (,) i spację między nazwami. W tym drugim przypadku cały tekst jest po prostu kopiowany do wygenerowanego dokumentu bez parsowania. Dlatego używaj wielu nazw w wierszu, jeśli chcesz zlokalizować separator nazw inny niż przecinek.

Myślę, że najlepiej pozostawić to systemowi kontroli wersji.

Podoba mi się funkcja obwiniania w GIT. Możesz zobaczyć, kto jest autorem każdej części / linii kodu. Nie tylko plik.

Jeśli pracujesz nad dużym projektem z wieloma współautorami, adnotacje dla każdego pliku z listą autorów po prostu nie działają. Co robisz z listą autorów, dzieląc plik na kilka mniejszych plików? Czy zachowałeś oryginalną nazwę autora, jeśli całkowicie przepisałeś kod? Czy dodajesz swoje nazwisko do listy autorów, gdy naprawiasz literówkę w komentarzu?

Te pytania lepiej pozostawić systemowi kontroli wersji.

Ale nie jestem całkowicie przeciwny liście autorów. Prowadzenie listy autorów całego projektu ma sens. Jeśli jest to projekt z jednym plikiem, na pewno trzymaj go w tym samym pliku. Jeśli jest to większy projekt, przechowuj go w README lub pliku źródłowym najwyższego poziomu (aka main.c). Ale nie powtarzaj się, wymieniając autorów w każdym pliku.

Śledzimy za pomocą systemu kontroli wersji lub poprzez umieszczenie @authorw kodzie. Innym sposobem jest powiedzenie bardziej ogólnie, że niektóre osoby były autorami całych modułów lub całego programu. To zachęca ludzi do myślenia o sobie jako o członku zespołu, a nie o zębatce w maszynie, która odpowiada za dokładnie X funkcji lub linii kodu.

Używam komentarzy w stylu Doxygen (lub czasami KernelDoc) do prawie wszystkiego. Pracuję głównie w C i PHP, gdzie Doxygen jest dość popularny.

W większości przypadków pomocne jest co najmniej następujące informacje:

• Zezwolenie (lub nie) na jego kopiowanie / Prawa autorskie firmy lub osoby fizycznej
• Nazwisko autora / adres e-mail
• Data napisania
• Data ostatniej modyfikacji

Powinno to pomóc każdemu, kto akurat pracuje nad plikiem, wiedzieć, co ma, co może z nim zrobić i kogo może poprosić o pomoc, jeśli tego potrzebuje. Mówi im także, czy patrzą na coś 10 lat.

Nie robię tego osobiście, ponieważ jest to dodatkowa dokumentacja, która, jak powiedzieli inni, znajduje się w kontroli wersji. Ale gdybym miał zamiar zrobić snippit z kodu kung-fu, prawdopodobnie byłbym skłonny zastosować wszystko, co moje IDE było w stanie wygenerować automatycznie.

Na przykład, używanie w Delphi 7 z tymi pomocnymi zainstalowanymi CNTools piszę

///a [enter]

i wychodzi

//<author></author>

potem piszę

///d [enter]

i wychodzi

 //<date></date>

Wyobrażam sobie, że odpowiada to temu, co może pochwycić jakieś narzędzie innej firmy, ale jeśli chodzi o mnie - mam standard, którego nawet nie musiałem wymyślić i zepsuć.