LogFAQs > #962299576

LurkerFAQs, Active DB, DB1, DB2, DB3, DB4, DB5, DB6, DB7, DB8, Database 9 ( 09.28.2021-02-17-2022 ), DB10, DB11, DB12, Clear
Topic List
Page List: 1
TopicNot commenting your code is job security
s0nicfan
02/02/22 11:11:19 AM
#30:


MutantJohn posted...
I think you confused this with "writing your tests before writing the code".

Plus, safety-critical has extra components in the workflow added to it.

Again, comments really don't matter. They help, for sure, but they don't imply 1. software quality and 2. what the software actually does.

Comments are all talk whereas code is all walk, baby.

Both, but I meant commenting. It's incredibly useful to write a function description prior to writing code because you want to document what it SHOULD do so when things go wrong and someone else is trying to debug they undertand what the original intent was. Plus inline commenting prior to writing code is incredible for organization and structure. If you write your block comments before putting the implementation underneath, it also means any TODOs you throw in there are paired with what it eventually has to do. It saves a lot of time in the long run because you've fully thought through the end-to-end functionality of a function prior to starting the process of implementing it which catches any gaps in logic but also means if you have to resume another day its easy to tell where you left off.

---
"History Is Much Like An Endless Waltz. The Three Beats Of War, Peace And Revolution Continue On Forever." - Gundam Wing: Endless Waltz
... Copied to Clipboard!
Topic List
Page List: 1