How do you safely handle undocumented legacy logic?
I'm working through an older service and found a block of logic that clearly handles some unusual edge case, but there's no comment explaining why. The original author…
code documentation
Should method documentation comments go before or inside the method?
When documenting a method, where should the comment normally go: immediately before the method declaration, or inside the method body near the opening brace? For example, should the…
How do you handle undocumented code that seems to protect against an unknown edge case?
I'm working through an older service and found a block of logic that clearly seems to handle an unusual but important edge case. There's no explanation in the…
Where Should Comments Go When Documenting a Method?
When documenting a method definition, should the comment appear before the method signature or inside the method body? For example, should I write a comment immediately above the…
Should I be adding comments to my beginner C++ programs?
I'm taking an introductory C++ class, and the assignments are still pretty simple. If I understand what every line does and can write a program that solves the…
What local AI agent can document a VB.NET codebase as Markdown?
I'm new to local AI agents and want to experiment with one that can inspect an entire Visual Studio solution and explain how each project works in user-friendly…
What’s your routine for getting back into a codebase after a few days away?
I work on a fairly complex service layer, and whenever I return after a long weekend—or even just a couple of days away—the first 30–60 minutes often disappear…
How Should a Beginner Document Small VBA Projects?
I'm a self-taught beginner who has been learning programming gradually. Since I use Microsoft tools at work, I'm currently writing VBA to build small utilities for my job.…
What AI is best for understanding a critical, decade-old PowerShell script?
I need to understand a several-thousand-line PowerShell script that is about ten years old and still plays a critical role in an organization's HR and Active Directory processes.…
How should a beginner practically document small VBA projects?
I'm a self-taught programmer and still learning the fundamentals. Since I work heavily with Microsoft tools, I'm currently using VBA to build small utilities for my day job.…
Where should one-off bulk-operation code be stored for future reference?
I've worked in development and DevOps for decades, often maintaining both the application and its data. Occasionally, a system such as a CMS, DMS, CRM, or IAM platform…
What’s the best approach for multi-layered project documentation?
I'm starting a new team and have a lot of freedom in how I want to set things up. We're primarily developing Windows Forms using C# and Visual…
How Can I Effectively Understand Existing MATLAB Code for Conversion to Python?
Hey everyone! I've been tasked with converting a substantial solution written in MATLAB (over 1000 lines) into a combination of internal tools and Python. The first challenge is…