«documentation» etiketlenmiş sorular

Bu taş üzerine tökezlediğimde, teknik belgelere semantik / ontoloji tabanlı yaklaşımları (raslantısal olarak) araştırıyordum : Okuryazar Programlama ve Semantik Web, farklı zamanlardan gelen ve bir bağlantısı olan fikirlerdir. Norman Walsh'un XML'de Okuryazar Programlama adlı bağlantılı makalesi, anlamsal ağın merkezinde bulunan XML teknolojilerini tartışıyor, ancak okuryazar programlama ile anlamsal web veya …

9 documentation  semantic-web  literate-programming 

Matematiksel veya yapısal olarak oldukça karmaşık ve indirgenemez bir kod parçam varsa, bu kod parçasını belgelemeye nasıl devam edebilirim? Özellikle, yaptığım matematik veya mimari becerilere sahip olmayan birinin bunu belgelerden anlayabilmesini nasıl sağlayabilirim? Tüm matematiği de belgelemeli miyim? Bir öğreticiye bağlantı? Karmaşık yapılarda görsel yardım bağlantısı var mı?

9 documentation 

İlk olarak, bu sorunun biraz uzun ve belirsiz olabileceğini ve bunun için özür dilerim. Bu muhtemelen "anlayan" herkes için kısa bir adla temel bir sorundur, ancak kendimi bu konuda eksik bulduğumdan, lütfen sorunu açıklarken yanımda olun. Yaklaşık 11 yaşımdan beri bu şekilde ya da bu şekilde programlama yapıyorum. Bu, çoğunlukla …

9 documentation  design  modeling 

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ı . Geçmiş çalışanlarımızın iş açısından kritik bir sistemde yaptıkları özelleştirme konusunda çok az dokümantasyona sahip …

9 documentation 

Javadoc'u KURU bir şekilde yazmak istiyorum. Ancak Javadoc hakkındaki oracle belgesi , aşırı yük yöntemi yorumunda tekrar aynı şeyi yazdığını söylüyor. Tekrardan kaçınamaz mıyım?

9 documentation  comments  dry  javadocs 

Kurumsal düzeydeki ilk uygulamamı alıyorum ve ekibimin bir kod satırına bile dokunmadan önce tüm ASP.NET MVC C # uygulamasını modellemesini istiyorum. GÜNCELLEME: Bu, bir başvurunun ne zaman belgeleneceği / modelleneceği hakkında felsefi bir tartışma olarak tasarlanmamıştır. Lütfen yalnızca dokümantasyon / modelleme için "nasıl" yanıtları verin. Gerçek şu ki, bu departmanda …

9 c#  asp.net-mvc  documentation  uml 

Yani hataları düzeltiyorsunuz, o zaman yazılım ürününün diğer modüllerini etkileyebilecek bir hata ile karşılaştınız. Verileriniz, düzeltmenin etkileri hakkındaki talebinizi desteklemek için yeterli değildir ve sizden bir etki analizi belgesi oluşturmanız istenmiştir. Bunun nasıl yapılacağına dair tanımlanmış bir süreç var mı? Gerekli temel bilgiler nelerdir? Bu belge için bilinen herhangi bir …

9 project-management  documentation 

Gereksinim yönetimini geliştirmenin yollarını arıyorum. Şu anda bir Web sitesinde yayınlanan bir Word belgesimiz var. Maalesef bir revizyondan diğerine değişikliklere bakamayız. Ben büyük bir wiki veya VCS (ya da her ikisi de, wiki bitbucket gibi!) Gibi, bunu yapmayı tercih ederim. Ayrıca, her belgede geliştiricilerin belirli bir süre içinde karşılaması beklenen …

9 documentation  project-management  wiki  requirements 

Bu aptalca bir soru olabilir, ama bir süredir kafamın arkasındaydı ve başka hiçbir yerde iyi bir cevap bulamıyorum. Sadece bir tane olsa bile her parametreyi bir açıklama ile açıkça listelememiz gerektiğini söyleyen bir öğretmenim var. Bu bir çok tekrarlamaya yol açar: double MyFunction(const int MyParam); // Function: MyFunction // Summary: …

9 documentation  comments  coding-style