Python documentation tools and techniques
When writing code documentation, there are a number of tools and techniques to choose from. In this section, we will discuss some of the most common methods used by developers.
How to do it...
- Code obfuscation: First, a quick diversion into how to make your code difficult to read. There are valid reasons to obfuscate your code and make it difficult to read, such as attempting to prevent reverse-engineering. Other people just like the challenge; consider the International Obfuscated C Code Contest (http://ioccc.org).
On the other hand, making your code difficult to read can be an attempt to create malware that can bypass detection programs. One example is JSF**k, which converts JavaScript code into the atomic parts of JavaScript using only six different symbols, as shown in jsf.js from http://www.jsfuck.com. The file demonstrates the obfuscated equivalent of alert("This was a hidden message"), but any valid JavaScript code can be replicated using the...
