Pertanyaan yang diberi tag «documentation»

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 sebenarnya memiliki fitur komentar multiline?

1157 python  comments  documentation 

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 jelek?

936 swift  documentation 

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 telah melihat beberapa gaya penulisan dokumen dengan Python, apakah ada gaya resmi …

888 python  coding-style  documentation  docstring 

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 ini dapat diperbaiki dan mungkin dibuka kembali, kunjungi pusat bantuan untuk …

258 documentation  comments 

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 Salah satu fitur baru Xcode 5 adalah kemampuan untuk mendokumentasikan kode Anda sendiri dengan sintaks …

186 objective-c  documentation  comments  doxygen  xcode5 

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 target caranya: string, metode down-atau re-sampling, default ke 'mean' Jadi …

184 python  documentation  pandas 

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 . Perbaiki pertanyaan ini Ok, jadi saya sudah membaca PEP 8 dan PEP 257 …

167 python  documentation  module 

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 . Perbaiki pertanyaan ini Saya saat ini mulai dengan Python dan saya memiliki latar …

162 python  documentation  javadoc  docstring 

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 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero …

148 python  documentation  documentation-generation 

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 berikut: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public …

139 c#  .net  documentation  intellisense 

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 Saya mencoba mencari dokumentasi untuk menggunakan FFmpeg C API. Tampaknya hanya dokumentasi baris perintah …

120 c  api  documentation  ffmpeg 

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 ini TeX / LaTeX sangat bagus, saya menggunakannya dalam banyak hal. Beberapa kelebihannya …

118 documentation  latex  tex 

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 ini Saya sedang menulis kelas ringan yang atributnya dimaksudkan agar dapat diakses publik, …

115 python  class  documentation  docstring  class-attributes 

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... } Bagaimana Anda mengganti tanda tanya di bawah ini dengan menentukan sebuah array …

105 javascript  documentation  jsdoc 

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] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) Apa arti tanda …

103 api  documentation