Pertanyaan yang diberi tag «javadocs»

Baru-baru ini saya telah mengerjakan refactoring bagian-bagian dari basis kode yang saat ini saya tangani - tidak hanya untuk memahaminya dengan lebih baik, tetapi juga untuk membuatnya lebih mudah bagi orang lain yang mengerjakan kode. Saya cenderung bersandar pada sisi berpikir bahwa mendokumentasikan kode sendiri itu bagus . Saya hanya …

18 java  documentation  refactoring  javadocs 

Apakah ada istilah yang baik yang serupa tetapi berbeda dari "mencela" yang berarti bahwa metode atau API ada dalam basis kode tetapi tidak boleh digunakan karena implementasinya tidak lengkap atau kemungkinan akan berubah? (Ya, aku tahu, metode-metode itu seharusnya tidak bersifat publik, yada yada yada. Aku tidak menciptakan situasiku, aku …

12 documentation  terminology  api  documentation-generation  javadocs 

Dalam JavaDoc X509Certificate getSubjectDN()untuknya menyatakan: Diturunkan , diganti oleh getSubjectX500Principal (). Saya terbiasa melihat usang dalam metode yang tidak boleh digunakan lagi, tetapi tidak direndahkan. Saya menemukan laporan bug tentang kasus khusus ini di mana ditutup dengan komentar: Ini bukan bug. "Tidak berlaku lagi" dimaksudkan untuk digunakan hanya dalam kasus-kasus …

11 java  terminology  javadocs 

Saya sedang mengerjakan perpustakaan kecil yang menyediakan implementasi metrik string dasar yang terkenal. Sebagian besar untuk pendidikan saya sendiri. Jadi pengembangan terjadi setiap kali saya punya sedikit waktu luang. Karena ini saya telah mengotomatisasi sebagian besar proses sehingga saya dapat merilis versi sesering saya mengerjakannya tanpa terlalu banyak usaha. Namun …

9 java  documentation  javadocs 

Saya ingin menulis Javadoc dengan cara KERING. Tetapi dokumen oracle tentang Javadoc mengatakan menulis hal yang sama lagi dalam komentar metode overload. Bisakah saya menghindari pengulangan?

9 documentation  comments  dry  javadocs