Documentating software is part of the life of software engineers. But what kind of documentation do we need? In this episode I take you through three levels of documentation: the basic README and LICENSE files everyone should have, how to be good at writing git commit messages and using tools to turn your source code comments into browsable documentation. Links https://www.sphinx-doc.org/https://pdoc.dev/docs/pdoc.htmlhttps://docs.python.org/3/library/pydoc.htmlhttps://wiki.python.org/moin/Do...
All content for UCL for Code in Research is the property of Peter Schmidt and is served directly from their servers
with no modification, redirects, or rehosting. The podcast is not affiliated with or endorsed by Podjoint in any way.
Documentating software is part of the life of software engineers. But what kind of documentation do we need? In this episode I take you through three levels of documentation: the basic README and LICENSE files everyone should have, how to be good at writing git commit messages and using tools to turn your source code comments into browsable documentation. Links https://www.sphinx-doc.org/https://pdoc.dev/docs/pdoc.htmlhttps://docs.python.org/3/library/pydoc.htmlhttps://wiki.python.org/moin/Do...
Here we touch on some ways to build classes in C++ and how class design such as class hierarchies can help to make code more readable, more maintainable and less error prone (amongst other things). Klaus Iglberger and I also touch on design patterns and briefly what other programming paradigms exist apart from object oriented programming (OOP). Links https://medium.com/javascript-scene/the-forgotten-history-of-oop-88d71b9b2d9f The forgotten history of OOPhttps://medium.com/@ryan_forrester_/st...
UCL for Code in Research
Documentating software is part of the life of software engineers. But what kind of documentation do we need? In this episode I take you through three levels of documentation: the basic README and LICENSE files everyone should have, how to be good at writing git commit messages and using tools to turn your source code comments into browsable documentation. Links https://www.sphinx-doc.org/https://pdoc.dev/docs/pdoc.htmlhttps://docs.python.org/3/library/pydoc.htmlhttps://wiki.python.org/moin/Do...
