«documentation» etiketlenmiş sorular

W3Schools , eksik, bazen yanlış ve reklam ile basmış olma üne sahiptir; yine de, bir SO sorusunu yanıtlarken bazı şeyleri aramak veya belgelere bağlantı ararken, hala tek kullanışlı tarayıcı kaynağıdır. JavaScript'i belgelemek için giderek daha büyük bir iş yapan Mozilla Geliştirici Ağı ve efsanevi ve harika Quirksmode gibi başka kaynaklar …

12 web-development  documentation  html  css 

Ürün yelpazemizdeki dokümantasyonun yenilenmesine bakıyoruz. Bunun bir kısmı, sistemin bir parçası olarak kullanılan bir programlama dili için referans kılavuzları içerir . Bir programlama dili için referans kılavuzu yazarken, dili yeni olanlar için maksimum kullanılabilirlik için yapılandırmanın en iyi yolu nedir? Belgelenen her bir anahtar kelimenin temel özellikleri nelerdir ? Sözdizimi …

12 programming-languages  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 . 6 yıl önce kapalı . Bir proje için, bazı eski oyunlardan ve ilgili yazılımlardan - yapılandırma dosyaları, tasarruflar, kaynak …

12 documentation  reverse-engineering 

İş kurallarını belgelemenin resmi ve en çok uygulanan yönteminin ne olacağını merak ediyorum? Ayrıca geliştirme yapay nesnelerinin kullanıcı arabirimi özelliklerini nasıl belgelersiniz (örn. Form alanlarını belgelendirme ve düğmelerin form, bilgi metni vb. Üzerinde nasıl davrandığı)

12 documentation  business-rules 

Şu anda harici bir şirkette bireysel olarak karmaşık yazılım geliştirmem gereken "Yazılım Geliştirme" çalışmalarım için mezuniyetim üzerinde çalışıyorum. Tüm bunların, ilgili tüm belgeleri oluşturarak yapılandırılmış bir şekilde yapılması gerekir. Bu proje için IEEE standart belgeleriyle çalışmayı seçtim: Yazılım Gereksinimleri Belgesi (SRS), Yazılım Mimarisi Belgeleri (SAD) ve Yazılım Tasarım Belgesi (SDD). …

11 design  documentation  software  iso 

Kapalı. Bu soru konu dışı . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu Yazılım Mühendisliği Yığın Değişimi için konuyla ilgili olacak şekilde güncelleyin . 6 yıl önce kapalı . Kaynak kodu ve yazılım ürünlerini belgelemenin savunucusuyum. Benim kişisel deneyimim ve gözlemlerim, titizlikle yorumlanan kaynak kodları üzerinde …

11 productivity  documentation  code-quality  maintainability  engineering 

Normal ifadeleri yorumlamak için yaygın uygulamalar var mı: RegEx'in farklı kısımlarına atıfta bulunan satır içi yorumlar veya tüm ifadeler için genel yorum?

11 documentation  coding-style  comments 

Üniversite için hemen başlamayacağım, ancak oldukça uzun bir süredir düşündüğüm bir projem var. Üniversite proje geliştirmesinin sanayi gibi olmadığını anlıyorum (şu anda kendim stajyerim), bu yüzden şu anda işaret edeceğim durum muhtemelen gerçek yazılım geliştiricileri için biraz saçma görünecektir. ^^' Projenin kendisi, çalışmalarımızın çoğunu belgelememizi gerektiriyor. Bu nedenle, bazı işaretlere …

11 documentation  iterative-development 

Bazen, en ağır düşük düzeyli optimizasyona ihtiyaç duyan, yeterince yoğun olan kodun% 1'i vardır. Genel olarak video işleme, görüntü işleme ve her türlü sinyal işleme örnek gösterilebilir. Amaçlar , kodun sürdürülemez hale gelmemesi ve yeni geliştiriciler tarafından kaldırılmaya eğilimli hale gelmemesi için optimizasyon tekniklerini belgelemek ve öğretmektir . (*) (*) …

11 documentation  code-reviews  optimization 

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 

Ünlü açık kaynaklı projeleri inceleyerek programlama becerilerimi geliştirmek istiyorum, ancak kaynak kodlarına atlayarak kaybolmanın kolay olduğunu düşünüyorum. Bu yüzden önce kodlarının organizasyonu hakkında genel bir fikir edinmek için tasarımları veya mimarileri (UML diyagramları gibi) hakkındaki belgelerini okumaya karar verdim. Ancak, sürpriz olarak, Hibernate, Spring, ASP.NET MVC, Rails, vb. Gibi büyük …

11 open-source  documentation  asp.net-mvc 

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ı . Son zamanlarda yazılım projeleri için bazı öneriler okudum ve gördüklerimden biraz endişeliyim. Genellikle tekliflerin …

11 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ı . Kod yazmadan önce, önce kod kodunu oluşturmaya çalışan var mı? Bunu daha önce düşünüyordum çünkü somut bir …

11 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 . 4 yıl önce kapalı . Belgelenmemiş / özel API'yi nasıl bulduğunuzu her zaman merak ettim. Örnek Elma belgesiz / …

11 programming-languages  learning  documentation  api 

Çok fazla arama yaptıktan sonra, yazılım geliştirme dünyasında bilinen bir varsayımla ilgili temel bir soruya cevap veremedim: NE BİLİNİYOR: Yeterli kod dokümantasyonu (Doxygen etiketleri, Javadoc ya da sadece çok sayıda yorum olsun) konusunda katı bir politika uygulamak, kod geliştirmek için gereken süreye ek yük getirir. FAKAT: Kapsamlı belgelere (hatta bir …

11 java  c#  c++  documentation  coding-standards