«documentation» etiketlenmiş sorular

Kısa süre önce Python okumaya başladım , ancak çok satırlı yorumların nasıl uygulanacağını bulamadım. Çoğu dilde aşağıdaki gibi blok yorum sembolleri bulunur: /* */ Bunu Python'da denedim, ancak bir hata atıyor, bu yüzden bu muhtemelen doğru yol değil. Python'un aslında çok satırlı bir yorum özelliği var mı?

1156 python  comments  documentation 

Objective C'de, #pragma markkodumun bölümlerini sembol gezgininde işaretlemek için kullanabilirim . Bu bir C önişlemci komutu olduğundan, Swift'te mevcut değildir. Swift'te bunun için bir stand-in var mı, yoksa çirkin yorumlar kullanmak zorunda mıyım?

936 swift  documentation 

Kapalı . Bu soru görüş temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Bu yayını düzenleyerek gerçekler ve alıntılarla yanıtlanabilmesi için soruyu güncelleyin . 2 yıl önce kapalı . Python'da birkaç farklı yazım öğretisi gördüm, resmi veya “üzerinde anlaşılan” bir tarz var mı?

888 python  coding-style  documentation  docstring 

Şu anda olduğu gibi, bu soru Soru-Cevap formatımıza uygun değil. Yanıtların gerçekler, referanslar veya uzmanlık tarafından desteklenmesini bekliyoruz, ancak bu soru muhtemelen tartışma, tartışma, oylama veya genişletilmiş tartışma talep edecektir. Bu sorunun geliştirilebileceğini ve muhtemelen yeniden açılabileceğini düşünüyorsanız, yardım için yardım merkezini ziyaret edin . 7 yıl önce kapalı . …

258 documentation  comments 

Kapalı. Bu soru Yığın Taşması yönergelerine uygun değil . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu Yığın Taşması için konuyla ilgili olacak şekilde güncelleyin . 2 yıl önce kapalı . Bu soruyu geliştir Biri Xcode 5'in yeni özellikleri özel bir açıklama sözdizimi ile kendi kod belgelemek …

186 objective-c  documentation  comments  doxygen  xcode5 

Bu yüzden yeniden örneklemenin nasıl kullanılacağını tamamen anlıyorum , ancak belgeler seçenekleri açıklayan iyi bir iş yapmıyor. Bu nedenle, resampleişlevdeki çoğu seçenek bu ikisi hariç oldukça basittir: kural: hedef dönüşümü temsil eden uzaklık dizesi veya nesne nasıl: string, aşağı veya tekrar örnekleme yöntemi, varsayılan olarak 'mean' Çevrimiçi bulduğum kadar çok …

184 python  documentation  pandas 

Kapalı . Bu soru görüş temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Bu yayını düzenleyerek gerçekler ve alıntılarla yanıtlanabilmesi için soruyu güncelleyin . 2 yıl önce kapalı . Bu soruyu geliştir Tamam, ben de okumak ettik PEP 8 ve PEP 257 ve ben işlevleri ve …

168 python  documentation  module 

Kapalı . Bu soru görüş temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Bu yayını düzenleyerek gerçekler ve alıntılarla yanıtlanabilmesi için soruyu güncelleyin . 2 yıl önce kapalı . Bu soruyu geliştir Şu anda Python ile başlıyorum ve güçlü bir PHP arka planım var ve PHP'de …

162 python  documentation  javadoc  docstring 

Şu anda şirket içindeki diğer geliştiriciler tarafından dahili olarak kullanılacak küçük bir çerçeve yazıyorum. İyi Intellisense bilgileri sağlamak istiyorum, ancak atılan istisnaları nasıl belgeleyeceğimden emin değilim . Aşağıdaki örnekte: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this may throw FileNotFoundException …

139 c#  .net  documentation  intellisense 

Python'un belge dizelerini kullanarak yöntemleri parametrelerle nasıl belgeleyebilirim? EDIT: PEP 257 bu örneği verir: 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 ... Bu …

139 python  documentation  documentation-generation 

Kapalı. Bu soru Yığın Taşması yönergelerini karşılamıyor . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek mi istiyorsunuz? Yığın Taşması için konuya uygun olması için soruyu güncelleyin . 12 ay önce kapandı . Bu soruyu geliştirin FFmpeg C API'sini kullanmak için dokümantasyon bulmaya çalışıyorum. Görünüşe göre sadece komut satırı dokümantasyonu …

120 c  api  documentation  ffmpeg 

Kapalı . Bu soru fikir temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek mi istiyorsunuz? Bu yazıyı düzenleyerek gerçekler ve alıntılarla cevaplanabilmesi için soruyu güncelleyin . 6 yıl önce kapalı . Bu soruyu geliştirin TeX / LaTeX harika, birçok şekilde kullanıyorum. Avantajlarından bazıları şunlardır: metin dosyalarını kullanır, bu …

118 documentation  latex  tex 

Kapalı . Bu soru fikir temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek mi istiyorsunuz? Bu yazıyı düzenleyerek gerçekler ve alıntılarla cevaplanabilmesi için soruyu güncelleyin . 2 yıl önce kapalı . Bu soruyu geliştirin Öznitelikleri herkesin erişimine açık olan ve yalnızca bazen belirli örneklerde geçersiz kılınan hafif bir …

115 python  class  documentation  docstring  class-attributes 

JSDoc'ta, belirli bir türde bir diziniz varsa (örneğin bir dizi dizesi) aşağıdakileri kullanmak için bulabildiğim en iyi belgeler: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Aşağıdaki soru işaretlerini bir nesne dizisi belirterek nasıl değiştirirsiniz? /** * @param {???????} myObjects All of my …

105 javascript  documentation  jsdoc 

API belgelerinde fonksiyon arayüzlerinin sözdizimini yorumlamak için bir standart var mı ve eğer evet ise nasıl tanımlanıyor? Photoshop için "fillColor" işlevi için JavaScript komut dosyası kılavuzunda bulunan bir öğenin renginin nasıl değiştirileceğine ilişkin bir örnek: fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) Parantezlerin …

105 api  documentation