«documentation» etiketlenmiş sorular

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ı . amaç, aşağıdaki temel gereksinimlere sahip bir çevrimiçi dokümantasyon sistemine sahip olmaktır: esas olarak tüm başvurumuzun nihai teknik …

11 documentation 

KURU Prensibi (Kendinizi Tekrarlamayın) “her bilgi parçasının bir sistem içinde tek, açık, yetkili bir temsile sahip olması gerektiğini” belirtir. Çoğu zaman bu kod anlamına gelir, ancak genellikle belgelere de genişletilir. Her yazılım sisteminin seçmiş olsanız da olmasanız da bir mimariye sahip olduğu söylenir. Diğer bir deyişle, oluşturduğunuz yazılım bir yapıya …

11 agile  documentation  architecture  dry 

Ş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 çözülebileceğ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ı . …

11 project-management  business  management  documentation 

Yazılımımız, yansıma yoluyla dinamik olarak bulunması gereken birkaç sınıfa sahiptir. Sınıfların hepsinde, yansıma kodunun nesneleri başlattığı belirli bir imzası olan bir kurucu vardır. Ancak, birisi yönteme başvurulup uyulmadığını kontrol ettiğinde (örneğin, Visual studio Code Lens aracılığıyla), yansıma yoluyla başvuru sayılmaz. İnsanlar referanslarını kaçırabilir ve görünüşte kullanılmayan yöntemleri kaldırabilir (veya değiştirebilir). …

11 c#  .net  documentation  reflection 

Kendim için küçük komut dosyaları yazarken, kodlarımı yüksek yorumlarla yığarım (bazen ben koddan daha fazla yorum yaparım). Konuştuğum bir çok insan, kişisel olmasına rağmen bu senaryoları belgelemem gerektiğini söyledi, böylece onları satarsam hazır olurdum. Ancak yorumlar bir tür dokümantasyon değil mi? Bu olmaz: $foo = "bar"; # this is a …

11 documentation  comments 

Bence, birim test senaryolarının kendisi kod için bir dokümantasyon görevi görür. Şirketim, birim test senaryolarının üzerine ayrıntılı java doc yorumları yazmamı istiyor. Bunu yapmak gerekli mi? Bunun gibi yorumlar yazıyor musunuz?

11 unit-testing  documentation 

Harici geliştiriciler tarafından kullanılan ticari bir kütüphane ve kod örnekleri oluşturuyoruz. Kütüphanenin nasıl kullanılacağını kapsamlı bir şekilde açıklayan (kapalı, kayıtlı kullanıcılar tarafından kullanılabilir) belgelere sahibiz. Geliştiricilerin çoğu ilk kez kullanıldığından, birçok temel hata ile karşılaşılır. Hata günlüğüne belgelere bağlantılar eklemek uygun mu? Olası olumsuz yanları nelerdir? Birkaçını öngörebilirim, ancak aşağıdakilerin …

10 documentation  api-design  error-handling  error-messages 

Ben amatör bir geliştiriciyim ve şimdiye kadar tüm programlarım kod içinde belgelenecek kadar basitti. Kodu okurken böyle ve böyle bir eylem ne yaptığını açıktı (benim standart test 6 ay sonra koda bakmak ve ilk okuma her şeyi anlamak - ve kısa bellek süresi var). Şu anda aralarındaki çeşitli etkileşimleri hatırlama …

10 architecture  documentation 

Herhangi bir yazılım projesinde olduğu gibi gelecekte başka biri tarafından alınabilecek bir projedeki tek geliştiriciyim. Diyelim ki X özelliğini A özelliğini uygulamak için kullandım. Özelliği geliştirip bitirdikten sonra, yeni öğrendiğim Y desenini kullanarak aynı özelliği uygulayabileceğimin farkındayım. Ancak A özelliği iyi çalışıyor ve X'ten Y'ye yeniden düzenleme zaman alıcı ve …

10 design-patterns  refactoring  documentation 

Github README'de hangi bilgileri görmeyi beklersiniz? Her şey README'de olmalı mı? yani Giriş Kurulum Sürümler Kullanici rehberi uygulama Test yapmak alakalı kaynaklar Yoksa sadece bazı şeyleri README'ye (Giriş, Kurulum, Sürümler) koymanız gerekir ve diğer bilgiler en iyi Github wiki'sine yerleştirilir mi?

10 documentation  github 

Dokümantasyon için XML yorumları gerektiren bir hayranıydım. O zamandan beri iki ana nedenden dolayı fikrimi değiştirdim: İyi kod gibi, yöntemler de kendinden açıklamalı olmalıdır. Uygulamada, çoğu XML yorumu ek değer sağlamayan yararsız gürültüdür. Çoğu zaman genel yorumlar oluşturmak için GhostDoc'u kullanırız ve işe yaramaz gürültü ile kastediyorum: /// <summary> /// …

10 .net  programming-practices  development-process  documentation  comments 

Şu anki projemde çevik yöntemler kullanıyoruz ve bunun gibi birçok hikayemiz var: Bir asistan olarak, bir müşteriye, talep ettiklerinde biraz para alabilmeleri için geri ödeme yapmak istiyorum Bir müşteri olarak, öğemi alabilmem için bir satın alma işlemi için ödeme yapmak istiyorum. Şimdiye kadar yaptığımız her sprint en önemli hikayeleri seçmek …

10 agile  documentation  requirements  user-story 

Şu anda çalıştığım yerde genel yaklaşım - dokümantasyondan mümkün olduğunca kaçının Yalnızca farklı bir ekibin ihtiyaç duyacağını belgeleyin sadece açıklama için, kod dokümantasyonu demek istemiyorum - bunu yapıyoruz, tasarım sürecini çevreleyen tüm dokümantasyonları kastediyorum - eğer UML veya DB Şemaları, sınıf şemaları ve spesifikasyonları ve benzerleri olan kelime dokümanları. Patronumun …

10 documentation 

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 . 5 yıl önce kapalı . Şu anda ekip, üyeler genellikle aynı şirket içinde farklı projelere geçerek oldukça yüksek bir …

10 documentation  training 

Ben düzgün belgelenmiş kodun bir savunucusuyum ve bunun olası dezavantajlarının farkındayım . Bu, bu sorunun kapsamı dışındadır. Visual Studio'da IntelliSense'i ne kadar sevdiğimi göz önünde bulundurarak herkese açık XML üyeleri ekleme kuralını izlemeyi seviyorum. Ancak benim gibi aşırı bir yorumcunun bile rahatsız ettiği bir fazlalık biçimi vardır. Örnek olarak List.Exists …

10 documentation  comments  intellisense