«documentation-generation» etiketlenmiş sorular

Sembolik “O Zaman Verildi” senaryoları ile Davranış Odaklı Gelişim sözdizimi, son zamanlarda yazılım işlevsellik değerlendirmesi için bir sınır nesnesi olarak kullanılması muhtemel kullanımları nedeniyle oldukça karmaşık olmuştur . Gherkin'in veya hangi özellik tanımı komut dosyasını tercih ederseniz, işletme tarafından okunabilen bir DSL olduğu ve zaten böyle bir değer sağladığına kesinlikle …

24 documentation  bdd  documentation-generation  business-rules 

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 

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 

Şu anda kod belgelerini yazmak için iki sistem kullanıyorum (C ++ kullanıyorum): Yöntemler ve sınıf üyeleri hakkındaki belgeler Doxygen biçimi kullanılarak kodun yanına eklenir. Bir sunucuda Doxygen kaynaklar üzerinde çalıştırılır, böylece çıktı bir web tarayıcısında görülebilir Genel bakış sayfaları (bir grup sınıfı açıklayan, uygulamanın yapısı, örnek kod, ...) bir Wiki'ye …

13 documentation  documentation-generation  wiki 

Bir yöntem veya API'nin kod tabanında olduğu, ancak uygulamasının tamamlanmadığı veya büyük olasılıkla değişeceği için kullanılmaması gerektiği anlamına gelen "kullanımdan kaldırma" ifadesinden farklı ancak iyi bir terim var mı? (Evet, biliyorum, bu yöntemler herkese açık olmamalı, yada yada yada. Durumumu yaratmadım, sadece en iyisini yapmaya çalışıyorum.) İnsanlar ne önerir? Deneysel, …

12 documentation  terminology  api  documentation-generation  javadocs 

Kapalı . Bu sorunun daha fazla odaklanması gerekiyor . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu, yalnızca bu yayını düzenleyerek tek bir soruna odaklanacak şekilde güncelleyin . 4 yıl önce kapalı . Temelde PHP'de geliştirilen ve başka bir normal web uygulaması olan bir web uygulamasını tamamladım. …

11 project-management  documentation  documentation-generation  projects-and-solutions 

Kodumu belgeledim doxygen, ancak verdiği varsayılan HTML'yi istemiyorum. Özel CSS, üstbilgi, altbilgi vb. (GNOME'un yaptığı gibi) sağlayarak özelleştirebilirim ve dosyalara ortak PHP kodu ekleyebilir ve kaydetmeyi söyleyebilirim .php, ama bu gerçekten istediğim şey değil . İstediğim MSDN gibi çıktı. Gerçekten tarif edemem. Benim sorum, bu şablonlar gibi bir şey ile …

10 documentation  templates  documentation-generation