0
Kodumda pep8, pyflakes ve pylint kullanarak çalışıyorum; Hepsi benim Python kodumun içeriğini ve biçimini doğrular.Python: Doğrulama Sınıflar ve Yöntemler uygun şekilde belgelenmiştir (tür, argümanlar, döndürmeler, istisnalar)?
Şu an için arıyorum, Python kodumun düzgün ve tam olarak yorumlandığını doğrulamaktır. Örneğin, her yöntem için bir yorum varsa ve bu yöntemin argümanlarının her birinin yanı sıra beklenen getiriler ve istisnalar da yorumlanır. Sınıflar ve Sabitler ve Özellikler için bazı doğru.
Ayrıca kodumu belge oluşturma için Sfenks ve Doxygen'den geçiriyorum.
Thx
Bir çeşit [doc testing] (http://www.sphinx-doc.org/en/stable/ext/doctest.html) aradığını düşünüyorum. Ayrıca ana dokümanlardan da [burada] (https://docs.python.org/3/library/doctest.html). Gelecekte başvurmak için, tipik olarak yazılım önerileri almak SO için konu dışıdır. – idjaw
"Yorumlanan" ifadesinin "belgelenmiş" ile değiştirilmesi gerektiğini düşünüyorum. Yorumlar! = Docstrings. – mzjn
Cevabınız için teşekkür ederiz. Doğru, ** iyi belgelenmiş ** koduna başvurmaktaydım. Bununla birlikte, ** [doctest] (https://docs.python.org/3/library/doctest.html) ** modülü, etkileşimli Python oturumları gibi görünen metin parçalarını arar ve daha sonra bu oturumları yürütmek için bu oturumları yürütür. tam olarak gösterildiği gibi çalışın. – jeff00seattle