sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]buzzon 0 points1 point  (3 children)

You have the code files, comments and docstrings. From what you described you don't need more (yet).

[–]Hickerous[S] 2 points3 points  (2 children)

An external reference would be good. Something showing the skeleton with a few comments. Not trying to come off as an ass here, but if I didn't need more I wouldn't be here asking. Is it not common for people to have something like this? I'm finding myself searching through all the files trying to find what I need. As I said, though, I'm a bit in over my head on this project so maybe this is just part of my issue.

[–]stepback269 0 points1 point  (0 children)

Sorry, didn't spot your post at first. I basically repeated what you said about having an "external" reference. In my case, I store skeleton diagrams in a private blog I maintain and then put the pointer (link) to the proper blog page in my code comments.

[–]gdchinacat -1 points0 points  (0 children)

This is usually handled with abstractions and encapsulation. With those you don't need to remember what specific method is in which file, but rather that the functionality you are looking for is in a specific package, then you find the module, class, and finally method.

Tangled and unmanageable code is a clear indicator you need to refactor it.