this post was submitted on 31 Jul 2023
42 points (95.7% liked)

Programming

17672 readers
97 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 2 years ago
MODERATORS
[email protected]
[email protected]
[email protected]
42
No more code headers? (midwest.social)
submitted 1 year ago by [email protected] to c/[email protected]
17 comments fedilink hide all child comments
 

I recently hired into a data analytics team for a hospital, and we don't have a style guide. Lots of frustration from folks working with legacy code...I thought putting together a style guide would help folks working with code they didn't write, starting with requiring a header for SQL scripts first as low hanging fruit.

Or so I thought.

My counterpart over application development says that we shouldnt be documenting any metadata in-line, and he'd rather implement "docfx" if we want to improve code metadata and documentation. I'm terrified of half-implementing yet another application to further muddy the waters--i'm concerned it will become just one-more place to look while troubleshooting something.

Am I going crazy? I thought code headers were an industry standard, and in-line comments are regarded as practically necessary when working with a larger team...

you are viewing a single comment's thread
view the rest of the comments
[โ€“] [email protected] 7 points 1 year ago (1 children)

I like it better when the docs are embedded in the code or alongside them. Everywhere I've worked it is a pain trying to find some random Confluence page or whatever where some API doc is.

[โ€“] [email protected] 4 points 1 year ago

Also if it's not in the code, it will get outdated quickly and nobody will ever look at it. Separate docs are only really useful for main concepts that are not going to change that quickly.