Codetown
Codetown ::: a software developer's community
Documentation standards or guidelines?
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
Views: 140
Replies to This Discussion
-
Permalink Reply by Adam Davis on
-
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.
Happy 10th year, JCertif!
Notes
Welcome to Codetown!
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.
Looking for Jobs or Staff?
Check out the Codetown Jobs group.
InfoQ Reading List
Azure API Management Premium v2 GA: Simplified Private Networking and VNet Injection
Microsoft has launched API Management Premium v2, redefining security and ease-of-use in cloud API gateways. This new architecture enhances private networking by eliminating management traffic from customer VNets. With features like Inbound Private Link, availability zone support, and custom CA certificates, users gain unmatched networking flexibility, resilience, and significant cost savings.
By Steef-Jan WiggersPodcast: GenAI Security: Defending Against Deepfakes and Automated Social Engineering
In this episode, QCon AI New York 2025 Chair Wes Reisz speaks with Reken CEO and Google Trust & Safety founder Shuman Ghosemajumder about the erosion of digital trust. They explore how deepfakes and automated social engineering are scaling cybercrime and argues defenders must move beyond default trust, utilizing behavioral telemetry and game theory to counter attacks that simulate human behavior.
By Shuman GhosemajumderVercel’s Next.js 16: Explicit Caching, Turbopack Stability, and Improved Developer Tooling
Unlock the potential of full-stack web development with Next.js 16! This robust release features revolutionary Cache Components, enhanced routing, and Turbopack as the default bundler for lightning-fast builds. Experience architectural breakthroughs and AI-powered debugging. Upgrade today to optimize performance and streamline your development process!
By Daniel CurtisJEP 526 Simplifies Deferred Initialization Ahead of JDK 26
JEP 526 introduces Lazy Constants for JDK 26, enhancing developer ergonomics and performance. This feature replaces the earlier Stable Values, simplifying initialization while ensuring thread safety and immutability. With utilities for lazy lists and maps, it promotes efficient resource management, reducing startup costs. Feedback is welcomed to refine this API ahead of a potential future release.
By A N M Bazlur RahmanGoogle Introduces Nano Banana Pro with Grounded, Multimodal Image Synthesis
Google has released Nano Banana Pro. The system moves beyond conventional diffusion workflows by tightly coupling image generation with Gemini’s multimodal reasoning stack. The result: visuals that are not only aesthetically pleasing, but structurally, contextually, and informationally accurate.
By Robert Krzaczyński
© 2025 Created by Michael Levin.
Powered by
