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 Google Next '24 conference, Google unveiled Axion, its first custom Arm-based CPUs designed for data centers. Utilizing the Arm Neoverse V2 CPU architecture, the new processor will be available to customers later this year.
By Renato LosioAt QCon London, Rachael Greaves, chief executive officer at Castle Systems, presented both the obligations and benefits of data minimisation as a mechanism to decrease the impact of data breaches. AI autoclassification and automatic decision-making tools help with the ever-increasing data volumes as long as ethical principles are considered, allowing decisions to be challenged.
By Olimpiu PopJetBrains IDE Services aims to help enterprises manage their JetBrains tool ecosystem more efficiently and boost developer productivity at the enterprise scale through the integration of AI, remote collaboration, and more.
By Sergio De SimoneIn this podcast Shane Hastie, Lead Editor for Culture & Methods spoke to Dannielle Pearson about the importance of critical thinking in technology.
By Dannielle PearsonThis week Microsoft released Preview 6 of the .NET Aspire project. Significant changes have been implemented to enhance the security and reliability of the platform. This release, version 8.0.0-preview.6.24214.1, introduces several noteworthy additions, like changes related to templates, components, dashboard, testing and more.
By Almir Vuk© 2024 Created by Michael Levin. Powered by