Bagaimana Anda melacak pembuat kode? [Tutup]

Ini adalah sesuatu yang tidak pernah saya ajarkan. Saya telah melihat banyak jenis gaya penulisan yang berbeda. Saya kode terutama di Jawa dan Python. Saya bertanya-tanya apakah ada gaya penulisan standar atau apakah semuanya gaya bebas. Juga jika Anda menjawab, maukah Anda melampirkan gaya yang Anda gunakan ke file penulis yang Anda buat di rumah atau di tempat kerja.

Saya biasanya hanya pergi

@author garbagecollector
@company garbage inc.

Tidak sepenuhnya yakin apa yang Anda tanyakan, namun saya menggunakan gaya yang sangat ketat:

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

Gaya ini terinspirasi dari programer perakitan.

Saya meletakkan ini di bagian atas halaman yang saya butuhkan untuk "Penulis", terlepas dari apakah ini adalah kelas, file teks, atau prosedur tersimpan SQL dll.

Mengapa kamu akan? itulah tugas dari sistem versi dan "Salahkan" :)

Kami tidak melakukan penulisan di perusahaan saya. Sebagai gantinya, kami membiarkan kontrol versi kami yang menanganinya.

Setiap kali Anda check-in, itu melampirkan nama pengguna Anda ke daftar perubahan. Jika ada yang rusak, seseorang dapat kembali dan melihat perubahan sejarah untuk melihat apa yang telah berubah, kapan, dan siapa yang melakukannya. Ini juga rapi melihat grafik revisi untuk melihat bagaimana file telah berevolusi dari waktu ke waktu, siapa yang menyentuhnya, proyek apa yang telah bercabang darinya.

Masalah yang saya lihat dengan meletakkan tag penulis di kelas adalah bahwa seiring waktu itu kemungkinan besar lebih dari satu pengembang akan bekerja di kelas itu. Pembaruan, dan sejenisnya. Ini adalah langkah ekstra untuk memperbarui komentar penulis, dan langkah-langkah ekstra kecil cenderung sering dilupakan. Dengan demikian menjadi usang dengan cepat.

Saya tidak melakukan itu sama sekali. Saya pikir di tempat kerja kami memiliki beberapa templat yang dimasukkan ke dalam file dengan nama perusahaan dan userid dari orang yang terakhir memodifikasi file, tetapi saya tidak pernah memperhatikannya.

Secara umum, saya pikir itu tidak masalah bagaimana Anda melakukannya. Jika Anda ingin memberi cap pada file Anda, cukup pilih gaya yang konsisten dan ikuti.

JavaDoc sangat standar di komunitas Java:

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

@author nama-teks

Menambahkan entri "Penulis" dengan teks-nama yang ditentukan ke dokumen yang dihasilkan saat opsi -author digunakan. Komentar dokumen dapat berisi beberapa @authortag. Anda dapat menentukan satu nama per @authortag atau beberapa nama per tag. Dalam kasus sebelumnya, Javadoc menyisipkan koma (,) dan spasi di antara nama. Dalam kasus terakhir, seluruh teks hanya disalin ke dokumen yang dihasilkan tanpa diuraikan. Oleh karena itu, gunakan beberapa nama per baris jika Anda menginginkan pemisah nama yang dilokalkan selain koma.

Saya pikir itu sebaiknya diserahkan pada sistem kontrol versi.

Saya suka fitur menyalahkan di GIT. Anda dapat melihat siapa yang menulis setiap bagian / baris kode. Bukan hanya sebuah file.

Jika Anda mengerjakan proyek besar dengan banyak kontributor, menjelaskan setiap file dengan daftar penulis tidak berfungsi. Apa yang Anda lakukan dengan daftar penulis ketika Anda membagi file menjadi beberapa file yang lebih kecil? Apakah Anda menyimpan nama penulis asli jika Anda benar-benar menulis ulang kode? Apakah Anda menambahkan nama Anda ke daftar penulis ketika Anda memperbaiki kesalahan ketik dalam komentar?

Pertanyaan-pertanyaan ini lebih baik dibiarkan untuk sistem kontrol versi.

Tetapi saya tidak sepenuhnya menentang daftar penulis. Menyimpan daftar penulis untuk seluruh proyek masuk akal. Jika ini adalah proyek file tunggal, tentu, simpanlah di dalam file tersebut. Jika proyeknya lebih besar, simpan di README atau file sumber tingkat atas Anda (alias main.c). Tapi jangan ulangi diri Anda dengan membuat daftar penulis di setiap file.

Kami terus melacak menggunakan sistem kontrol versi atau dengan menempatkan @authordalam kode. Cara lain untuk melakukannya adalah dengan mengatakan secara lebih umum, bahwa orang-orang tertentu adalah penulis untuk seluruh modul atau untuk seluruh program. Itu mendorong orang untuk menganggap diri mereka sebagai bagian dari tim alih-alih sebagai roda penggerak dalam mesin yang bertanggung jawab atas sejumlah fungsi atau garis kode.

Saya menggunakan komentar gaya Doxygen (atau terkadang KernelDoc) untuk hampir semuanya. Saya kebanyakan bekerja di C dan PHP, di mana Doxygen cukup populer.

Dalam kebanyakan kasus, akan sangat membantu untuk setidaknya memasukkan informasi berikut:

• Izin (atau tidak) untuk menyalinnya / Hak cipta perusahaan atau individu
• Nama Penulis / e-mail
• Tanggal ditulis
• Tanggal terakhir diubah

Itu harus membantu siapa saja yang kebetulan mengerjakan file mengetahui apa yang mereka miliki, apa yang dapat mereka lakukan dengan itu dan siapa mereka dapat meminta bantuan jika mereka membutuhkannya. Ini juga memberi tahu mereka jika mereka melihat sesuatu yang berumur 10 tahun.

Saya pribadi tidak melakukan ini karena ini dokumentasi tambahan yang seperti yang dikatakan orang lain, ada dalam kontrol versi. Tetapi jika saya akan membuat semacam potongan kode kung-fu, saya mungkin akan cenderung untuk pergi dengan apa pun yang mampu dihasilkan oleh IDE saya secara otomatis.

Sebagai contoh, menggunakan Delphi 7 dengan CNTools bermanfaat yang saya ketik

///a [enter]

dan keluar

//<author></author>

maka saya mengetik

///d [enter]

dan keluar

 //<date></date>

Saya membayangkan itu berhubungan dengan sesuatu yang bisa didapat oleh utilitas pihak ke-3, tetapi bagi saya - saya punya standar yang bahkan saya tidak perlu berbaikan dan merusak diri sendiri.