Codetown ::: a software developer's community
Does anyone care to share their suggestions for documentation?
I'm asking because I recently had to change a program I wrote more than five years ago. I'd always thought that I've done a good job of documentation. But going through it was difficult. It WAS pulling apart an Excel in CSV format created and saved off by humans, so there was a lot of exception handling. But still . . . .
- Miek
Tags:
Generally I only put javadocs on public methods, especially ones that are used a lot. I use code comments sometimes, but generally if the code is hard to understand I take that as a "smell" that means you need to break down the code into more methods, refactor, or think about better naming.
Codetown is a social network. It's got blogs, forums, groups, personal pages and more! You might think of Codetown as a funky camper van with lots of compartments for your stuff and a great multimedia system, too! Best of all, Codetown has room for all of your friends.
Created by Michael Levin Dec 18, 2008 at 6:56pm. Last updated by Michael Levin May 4, 2018.
Check out the Codetown Jobs group.
In this InfoQ podcast, host Daniel Bryant sat down with speakers from the InfoQ Dev Summit Boston (June 24-25) and discussed the critical challenges and decisions developers are currently facing. Topics covered include platform engineering, the evolution of senior software developer roles into Staff-Plus positions, AI's impact on the SDLC, and the importance of security.
By Eder Ignatowicz, Loiane Groner, David Grizzanti, Thiago GhisiRecently, Microsoft announced the public preview release of the Last Will and Testament (LWT) support in Azure Event Grid's MQTT broker capability, which complies with the MQTTv3.1.1 and MQTTv5 specifications.
By Steef-Jan WiggersKate Sills discusses JavaScript libraries to use for cryptographic hashes, digital signatures and timestamping, the traditional archival process, and how cryptographic hashes can prevent tampering.
By Kate SillsStability AI recently released Stable Video 3D (SV3D), an AI model that can generate 3D mesh object models from a single 2D image. SV3D is based on the Stable Video Diffusion model and produces state-of-the-art results on 3D object generation benchmarks.
By Anthony AlfordPatterns can help us to understand how things work and how cultures develop. The game in an organisational system is about recognizing patterns and anti-patterns. According to Tiani Jones, leaders should work on the system rather than in the system and create the conditions for the development and sustainment of good patterns in software organisations.
By Ben Linders© 2024 Created by Michael Levin. Powered by