«documentation» etiketlenmiş sorular

Bazı dillerdeki belgeler neden "is" yerine "eşdeğer" diyor? Örneğin, Python Belgeleri diyor ki itertools.chain(*iterables) ... Eşdeğer : def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element Veya bu C ++ referans üzerinde find_if: Bu işlev şablonunun davranışı …

23 c++  python  documentation  compiler 

Kapalı . Bu sorunun daha fazla odaklanması gerekiyor . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu, yalnızca bu yazıyı düzenleyerek tek bir soruna odaklanacak şekilde güncelleyin . Geçen sene kapalı . Kodumu belgelemek istiyorum, aylar sonra tekrar kodu okumak ve taramak için minimum gereksinim olacak. Farklı …

22 documentation  code-reviews  documentation-generation  help-documentation 

Bu alanlar için Alıcı ve ayarlayıcıların "JavaBean" sözdizimi dahil belge her şeyi tartışmalı konu, biraz görünüyor: İnsanlar demek onun gereksiz uzun ve tekrarlayan kopma KURU (kendinizi tekrar etmeyin) , adlandırma kuralı açıklamak gerektiğini her şeyi , ve kod / dökümanları tutar. Bazen bu argümanlar işe yarar. Ama diğer zamanlarda, bununla …

22 documentation 

'Ünite testleri, test edilen kodun dokümantasyonu için çok önemli bir kaynaktır' damarı içindeki ifadeleri okuduğum sayıyı sayamıyorum. Onların doğru olduğunu inkar etmiyorum. Ama şahsen, kendimi onları dokümantasyon olarak kullanırken hiç bulamadım. Kullandığım tipik çerçeveler için yöntem bildirimleri davranışlarını belgeliyor ve ihtiyacım olan tek şey bu. Ve birim testlerinin bu dokümantasyonda …

22 unit-testing  documentation 

Şu anda işlevsel ve teknik özellikleri iki sütun biçiminde yazıyoruz; özet cümle ve teknik detay. Detaylar genellikle, şema, düzen tasarımları vb. Olan bir eke atıfta bulunur. Ancak yazmak için ne kadar gergin olduğumla mücadele ediyorum: İş bitmiş gibi geçmiş zamanla, var olan işin uzantılarını vurgulamak için mücadele ediyorum. Gelecekteki zamanın …

21 documentation  specifications  writing 

Arka plan: Ortak çalışanlarımız ve ben akademik bir dergi için bir makale yazıyoruz. Araştırmamız sırasında Java'da bir simülasyon programı yazdık. Simülasyon programını başkalarının kullanabileceği şekilde serbest bırakmak istiyoruz. Kodu bir GitHub deposunda barındırmaya karar verdik. Başkalarının kullanımını kolaylaştırmak için, programımız için aşağıdakiler de dahil olmak üzere iyi belgeler yazmak istiyoruz: …

20 java  documentation 

Yani böyle bir arayüzümüz var /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Son zamanlarda, yukarıdaki gibi çok sayıda XML dokümanının …

20 c#  documentation  xml  documentation-generation 

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 . 6 yıl önce kapalı . WordPress ve BuddyPress kullanarak bir yıl boyunca bir sosyal ağ projesinde çalıştıktan sonra , programcım, tüm hafta …

19 documentation  hiring  outsourcing  knowledge-transfer  wordpress 

Bazen, sık olmasa da, koduma matematik mantığı dahil etmek zorundayım. Kullanılan kavramlar çoğunlukla çok basittir, ancak sonuçta ortaya çıkan kod değildir - belirsiz amacı olan çok sayıda değişken ve çok açık olmayan bir amacı olan bazı işlemler. Ben bu sadece o kod okunamaz veya unmaintainable anlamına gelmez waaaay gerçek matematik …

19 java  documentation  math 

Son zamanlarda şu anda uğraştığım kod tabanının parçalarını yeniden düzenleme üzerinde çalışıyorum - sadece kendimi daha iyi anlamak için değil, aynı zamanda kod üzerinde çalışan diğerleri için de daha kolay hale getirmek için. Kendini belgeleyen kodun güzel olduğunu düşünmeye eğilimliyim . Sadece daha temiz olduğunu düşünüyorum ve kod kendisi için …

18 java  documentation  refactoring  javadocs 

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 . 5 yıl önce kapalı . Herkes iyi belgelenmiş yazılım geliştirmenin başarıya yol açtığını bilir. Ancak, genellikle UML diyagramı gibi belgede yalnızca düz …

18 documentation  wiki 

İşten ayrılan tek bir geliştirici olduğunuzu varsayın. Kodunuzun dışında ne tür bilgi / materyaller oluşturmalı ve değiştirilmeniz için geride bırakmalısınız? Açık bir cevap, "yeni bir işte ne istersen" kesinlikle, ama yeni bir işe başladığımdan beri bir süredir ve o zamanlar ihtiyacım olan en önemli şeylerin ne olduğunu unutuyorum. Düşünüyorum: hesap …

18 documentation  knowledge-transfer 

Ekibimdeki geliştiricilerden biri, bir yöntemin imzasında HER parametre için bir javadoc yorumu yazmanın gerekli olduğuna inanıyor. Bunun gerekli olduğunu düşünmüyorum ve aslında zararlı bile olabileceğini düşünüyorum. Öncelikle, parametre adlarının açıklayıcı ve kendi kendini belgelemesi gerektiğini düşünüyorum. Parametrelerinizin ne için olduğu hemen belli değilse, muhtemelen Yanlış Yapıyorsunuzdur. Ancak, bazen bir parametrenin …

18 java  documentation  source-code  comments  maintainability 

Yazılım projelerini daha resmi olarak nasıl belgeleyeceğimizi araştırıyorum ve IEEE 830-1998: Yazılım Gereksinimleri Spesifikasyonları için Önerilen Uygulama hakkında bilgi edindim . Ancak, bu bağlantıdan da görebileceğiniz gibi, yerini almıştır. 830-1998'in ve muhtemelen 830-1993'ün muhtemelen kullanım için iyi olduğunu biliyorum. Ancak, başka bir şey yoksa, hangi standardın yerini aldığını bilmek istiyorum. …

17 documentation  requirements  standards 

Hepimiz, aşağıdaki gibi "minimum sistem gereksinimleri" ile birlikte gelen sayısız yazılım örneği gördük: Windows XP / Vista / 7 1GB RAM 200 MB Depolama Bunlar genel olarak nasıl belirlenir? Açıkçası bazen belirli kısıtlamalar vardır (program diskte 200 MB alırsa, bu zor bir gereksinimdir). Bu durumların yanı sıra, RAM veya işlemci …

17 documentation  requirements  qa