0
Интересно, следует ли включать специальные методы в Python, такие как __str__ или ___eq___ и т. Д. В диаграмме UML.Должен ли я включать специальные методы для класса Python UML?
A
ответ
2
Я бы сказал, сделайте это, только если они добавят полезную информацию читателям указанной UML-диаграммы.
Я бы сказал, что в любом случае любая документация должна быть написана только в том случае, если она полезна для ваших пользователей. Иначе это будет только в поисках других более важных вещей.
В случае строк документа вы должны обязательно написать метод docstring __hash__. И возможно сделать цитату в классе docstring.
Смежные вопросы
- 1. Должен ли я включать частные методы в диаграмму классов UML?
- 2. специальные методы - Python
- 3. Должен ли я включать Enumerable в NilClass?
- 4. Должен ли я включать jquery с kendo
- 5. Должен ли PYTHONPATH включать ./build/*?
- 6. Должен ли я включать `` include`` в `main() {}`?
- 7. Должен ли я включать response.js в заголовок?
- 8. Должен ли я включать каждый заголовок?
- 9. Как я должен случайно вызвать методы класса?
- 10. Устаревшие методы в диаграмме класса uml
- 11. Нужно ли включать переменные JButton в UML?
- 12. Почему я должен использовать методы класса Assert?
- 13. Должен ли я упоминать частные методы в файле заголовка класса?
- 14. Должен ли я объявлять методы абстрактного класса в соответствующем интерфейсе?
- 15. Специальные (магические) методы в Python
- 16. Должен ли я реализовывать все абстрактные методы в python 2.7?
- 17. Должен ли UML использоваться для создания GUI?
- 18. Должен ли я включать зависимости для моих выпусков?
- 19. Должен ли я включать testflightlib в мое приложение для iOS?
- 20. Должен ли я включать основной метод для JPA?
- 21. Должен ли я включать протокол для переменной окружения Meteor $ ROOT_URL?
- 22. Должен ли я использовать формальные методы для моего программного проекта?
- 23. Класс переопределения Python (не экземпляр) специальные методы
- 24. Должен ли я представлять собой служебный класс Java в UML?
- 25. Должен ли я включать подсказки пространства имен в имена классов?
- 26. Почему я должен включать индекс?
- 27. Должен ли я включать режим командной строки в свои приложения?
- 28. Python методы динамического класса
- 29. Должен ли я включать проверку подлинности в мои тесты rspec?
- 30. Должен ли я включать ту же библиотеку в разные iFrames?
какой если я реализую __hash__ специальный способ. Полезно ли в этом случае включить его? – lmiguelvargasf
Я бы сказал «нет». Поскольку ожидается, что хеш-функция хорошо себя ведет и имеет одну и ту же семантику на любом объекте. Я бы рассмотрел его как деталь реализации. – Governa
Вы имеете в виду докстрину по деталям реализации? – lmiguelvargasf