TAG INI HANYA UNTUK GENERATOR DOKUMEN. Sertakan tag bahasa dan / atau SDE juga. JANGAN GUNAKAN untuk meminta tautan ke dokumentasi atau alat, atau untuk mengkritik dokumentasi vendor.
Saya baru-baru ini mulai mempelajari Python , tetapi saya tidak dapat menemukan bagaimana menerapkan komentar multi-line. Sebagian besar bahasa memiliki simbol komentar blok seperti /* */ Saya mencoba ini dengan Python, tetapi ada kesalahan, jadi ini mungkin bukan cara yang benar. Apakah Python...
Di Objective C, saya dapat menggunakan #pragma markuntuk menandai bagian dari kode saya di navigator simbol. Karena ini adalah perintah preprocessor C, itu tidak tersedia di Swift. Apakah ada alasan untuk ini di Swift, atau apakah saya harus menggunakan komentar
Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 2 tahun yang lalu . Saya...
Seperti yang ada saat ini, pertanyaan ini tidak cocok untuk format tanya jawab kami. Kami berharap jawaban didukung oleh fakta, referensi, atau keahlian, tetapi pertanyaan ini kemungkinan akan mengundang debat, argumen, polling, atau diskusi panjang. Jika Anda merasa pertanyaan
Saat menulis dokumentasi xml dapat Anda gunakan <see cref="something">something</see>, yang tentu saja berfungsi. Tetapi bagaimana Anda merujuk kelas atau metode dengan tipe generik? public class FancyClass<T> { public string FancyMethod<K>(T value) { return "something...
Ini seharusnya lebih mudah ... Saya ingin menambahkan jeda baris "berkode" ke dokumentasi XML dalam kode saya /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a string with...
Tutup. Pertanyaan ini tidak memenuhi pedoman Stack Overflow . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga sesuai topik untuk Stack Overflow. Ditutup 2 tahun yang lalu . Perbaiki pertanyaan ini...
Saya tahu bahwa itu bukan masalah yang paling vital, tetapi saya baru sadar bahwa saya dapat meletakkan blok komentar javadoc sebelum atau setelah anotasi. Apa yang ingin kita adopsi sebagai standar pengkodean? /** * This is a javadoc comment before the annotation */ @Component public class...
Jadi saya benar-benar mengerti cara menggunakan resample , tetapi dokumentasi tidak melakukan pekerjaan dengan baik menjelaskan opsi. Jadi sebagian besar opsi dalam resamplefungsi ini cukup lurus ke depan kecuali untuk dua ini: aturan: string offset atau objek yang mewakili konversi...
Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 2 tahun yang lalu .
Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 2 tahun yang lalu .
Bagaimana saya bisa memberi tahu JSDoc tentang struktur suatu objek yang dikembalikan. Saya telah menemukan @return {{field1: type, field2: type, ...}} descriptionsintaks dan mencobanya: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event}...
Bagaimana cara mendokumentasikan metode dengan parameter menggunakan string dokumentasi Python? EDIT: PEP 257 memberikan contoh ini: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default...
Saat ini saya sedang menulis kerangka kerja kecil yang akan digunakan secara internal oleh pengembang lain dalam perusahaan. Saya ingin memberikan informasi Intellisense yang baik, tetapi saya tidak yakin bagaimana cara mendokumentasikan pengecualian yang dilemparkan. Dalam contoh...
Tutup. Pertanyaan ini tidak memenuhi pedoman Stack Overflow . Saat ini tidak menerima jawaban. Ingin memperbaiki pertanyaan ini? Perbarui pertanyaan agar sesuai dengan topik untuk Stack Overflow. Tutup 12 bulan yang lalu . Perbaiki pertanyaan ini...
Tertutup . Pertanyaan ini berdasarkan opini . Saat ini tidak menerima jawaban. Ingin memperbaiki pertanyaan ini? Perbarui pertanyaan agar dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Tutup 6 tahun lalu . Perbaiki pertanyaan...
Tertutup . Pertanyaan ini berdasarkan opini . Saat ini tidak menerima jawaban. Ingin memperbaiki pertanyaan ini? Perbarui pertanyaan agar dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Tutup 2 tahun lalu . Perbaiki pertanyaan...
Di JSDoc, dokumentasi terbaik yang dapat saya temukan menunjukkan menggunakan berikut ini jika Anda memiliki array dengan tipe tertentu (seperti array string) seperti: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here......
Apakah ada standar untuk menafsirkan sintaks antarmuka fungsi dalam dokumentasi API dan jika ya, bagaimana itu didefinisikan? Berikut adalah contoh tentang cara mengubah warna item panduan skrip JavaScript untuk Photoshop untuk fungsi "fillColor": fillPath ([fillColor] [, mode] [, opacity] [,...
The dokumentasi untuk memungkinkan integrasi xmldoc ke proyek-proyek Api Web Anda tampaknya hanya situasi pegangan di mana semua jenis API Anda adalah bagian dari proyek WebAPI Anda. Secara khusus, ini membahas cara mengubah rute dokumentasi XML ke App_Data/XmlDocument.xmldan menghapus komentar...