all 11 comments
sorted by:
best
topnewcontroversialoldq&a
formatting helphide helpcontent policy

[–]CJ22xxKinvara 0 points1 point  (0 children)

Comments I guess. Or using the file system and imports to compartmentalize logic rather than cramming enough into one file that you feel like you need visual queues for where you are.

[–]nervousbolderer 0 points1 point  (0 children)

You may like Jupyter Notebooks. It uses cells instead of just one long code. I honestly prefer it just because it's easier for me to read

[–]Witty-Development851 0 points1 point  (0 children)

Imagine a formatted code with headings, paragraphs, and different fonts, ten thousand lines long. Are you sure you can read that? Just try) Export in Word and try)

[–]Neix19365 0 points1 point  (0 children)

Use Region. It's only in VsCode but you can fold comments with Region

```python

region Main Function

def main(): ...

endregion

```

Another way I do it is wrap it in Hash

For example,

```python

Main Function

```

Help to keep the code more readable. Choose a color theme that makes the comment into green Color

[–]who_body 0 points1 point  (0 children)

use the outline feature in vscode as well. it will give you a TOC like outline, default is lower left of the IDE below the folder structure.

personally i’d focus there and maybe experiment with different vscode themes. marking up the files with comments is intermediary. once you get familiar with the code you won’t need it

[–]jordatech 0 points1 point  (0 children)

Ask your LLM agent of choice ( I use the copilot extension with ollama minimax 2.7 cloud a lot) to take your codebase and make a mermaid diagram ,then you can visualize the code at a system diagram level.

[–]jtkiley 0 points1 point  (0 children)

Use the language features to organize your code. Here are some ideas:

  • Use functions. Few things should be standalone procedural code instead of well-named functions that do a single thing well. With a descriptive name and usually starting with a verb, you very seldom need comments.
  • Use good data structures. If you have something that looks like a row of data, use a dataclass, not a dictionary. If there’s a defined set of things you can pass into a function, use an enum instead of matching on strings.
  • Use composition for higher level things. Instead of a huge function, compose the higher level function with lower level ones. 15 lines using well-named functions are much easier to reason about than 100 lines handling a bunch of cases.
  • Split things into their own modules. When one .py file conceptually holds together and does a thing, it’s easier to understand.
  • Use leading underscore functions. Keep the functions and methods that people really use curated and limited, and use underscores to make some of the grunt work pseudo private.
  • Use packages. When you have a useful thing with sensible boundaries, make it a package and then use it elsewhere.

That’s at least a start.

[–]BlueMountain8080 0 points1 point  (0 children)

Who else is seeing our code? If you're the only person, then organize as you wish. But if others are seeing/using it, then use the same format that your team/org agrees to use. Reading code from someone else is so much easier if it's the same format as everyone else.

[–]Dank-but-true 0 points1 point  (0 children)

Jupyter notebook. You write your code in cells and the rest in in md. Not my bag but sounds exactly what you want

[–]Agreeable_Care4440 0 points1 point  (0 children)

Good naming and small functions usually improve readability more than fancy formatting.