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.
During the recent Developer Week, Cloudflare announced that the object storage R2 now supports event notifications, which automatically trigger Workers in response to data changes. Additionally, the migration service Super Slurper now extends its support to Google Cloud Storage and a new infrequent access storage tier is available in private beta.
By Renato LosioGoogle has released Android 15 Beta. This version brings loudness control, screen recording detection, edge-to-edge apps by default, improvements for satellite connectivity and OpenJDK core libraries, new SQLite Apis, and more.
By Diogo CarletoMicrosoft recently announced significant updates to the Govern section of its Cloud Adoption Framework (CAF) for Azure, enhancing cloud governance guidance across various domains, including identity, cost management, and AI, to support better organizations, from startups to large enterprises, in their cloud journey.
By Steef-Jan WiggersIn this podcast Shane Hastie, Lead Editor for Culture & Methods spoke to Cassie Shum, VP of Field Engineering at Relational AI, about the importance of empathy in engineering culture and the key elements of building a strong team.
By Cassandra ShumSergey Bykov discusses the concept of Durable Execution, with a real world example of how they used it to build the Control Plane for Temporal Cloud.
By Sergey Bykov© 2024 Created by Michael Levin. Powered by