Eclipse ile küçük bir yazılım parçası yazıyorum. Pat Notz gibi Belgelerimi yazmak ve bunları Eclipse projemde bulundurmak için Latex kullanıyorum. Here'dan bahsedildi, en çok istediğim her klasörü kullanabileceğim. Benim durumumda bazı özel klasörler var mı yoksa genel olarak kötü bir fikir mi, aynı projenin içine belge ve kod eklemek mi?Bir Eclipse projesinin içinde nerede belge saklamak gerekir?
Projeniz için hangi dili kullanıyorsunuz? Java kullanıyorsanız, javadoc yorumlarını kullanabilir ve ardından javadoc kullanarak bir API/doküman oluşturabilirsiniz. Belgelerinizi istediğiniz yere koymak için de özgürsünüz. Kök dizininizde bir ana dosya, klasör başına bir dosya olabilir, gökyüzü sınırdır!
Java kullanıyorum. Nasıl belgelenir başka bir konudur. İyi bir döküman yazmayı düşünüyorum. Veritabanı, tablolar ve sütunlar üzerinde kendi yorumlarına sahiptir (== belgeler). Javadoc, bir fonksiyonun nasıl çalıştığını anlatmak için kullanılır. TDD kullanıyorsanız, test durumlarınız API'nızı nasıl kullanacağınızı gösteren bir göstergedir. Dolayısıyla belgelerim (özel bir proje), adlandırma kuralları ve genel yönler hakkında kısa bir özet olarak kullanılmaktadır. – user3417078
Javadoc, bir işlevin nasıl çalıştığını açıklamaktan daha fazlası için kullanılır. Bir sınıfın ne yaptığını, ne yapmadığını, bazı uygulama ayrıntılarını, istediğiniz her şeyi açıklamak için kullanabilirsiniz. [Liste] (https://docs.oracle.com/javase/7/docs/api/java/util/List.html) arayüzüne bir göz atın. Sınıf hakkında, nasıl kullanılacağı, ne yaptığı ve daha pek çok şey hakkında bilgi sahibidir. Davanız için, javadoc ya da bir metin dosyasını, uygun gördüğünüz her yerde, projenizle ilgili genel yönleri ve adlandırma kurallarını belgelemek için kullanabilirsiniz. –
Aslında bu belgelerin nerede saklanacağı kararınıza bağlı, Eclipse veya Java'nın belge adıyla ilgili bir şey yok. Ama genellikle insanlar onları 'doc' ya da başka bir şeye yerleştirme eğilimindedir. – Rugal
Projenin kök dizini altındaki bir doc dizinine koyardım. –