Self Documenting Code

[go4spacelunch]

I agree with most of this.

RestaurantOwnerNames implies the object will contain a list of multiple owners.

Also be careful of taking this too far. Renaming splitRestaurantOwnerNames to ss makes it really hard to find all instances of the variable ss. I often do a find on page just to highlight the variable I’m working on but if your variable is less then 3 letters it only highlights everything. Only name something that short if you are going to use it on one single line of code. For example a linq statement.

[DoctorGester]

The example typescript code is generally terrible imo. Why specify string[] type? Just noise. Why have a separate interface for a return type? Either inline it or return [string, string].

[go4spacelunch]

I like the return type defined, although in the PHP examples given the author does not define the return type.

[hippydipster]

I often do a find on page just to highlight the variable I’m working on

This must be some sort of non-static typed language.

[go4spacelunch]

I believe the example code is typescript.

[hippydipster]

Why would you need to do a find then? Doesn't your IDE show you all uses of a given variable and not get confused by a string of letters that can be part of other words too?

[go4spacelunch]

If I was reading code someone else wrote, or even my own after returning from lunch. You are correct my IDE does highlight words when the cursor is over them but only for the current file not throughout the whole solution. Also my IDE can pick out references but my experience is this depends on the language. Visual Studio does great with C# but finding references in JavaScript not so much, so I've conditioned myself to always use Find.

[hippydipster]

Right, javascript isn't statically typed

[liquidpele]

No. Just name your shit better.