2

I was reading about common practices for naming functions and variables. Most of the seasoned programmers say verb should be used when a function changes the state of the program, and noun should be used if the function is used to return a certain value.

UPDATE: please check https://stackoverflow.com/a/1991341/1088314 and https://softwareengineering.stackexchange.com/a/184867/217771 Both the authors have a reputation score of few thousands and they recommend it.

I am not quite clear about the meaning of change in the state of the program. What does it mean?

Community
  • 1
Sachin Divekar
  • 129
  • 1
  • 5

2 Answers2

5

In general changing in state of the program occurs when the program alters some computer resource (eg. memory value at a given address) within the process address space related to the process your program is represented by and that change will have an effect on further execution of the process. For example you call mutator (setter) on your object to alter its property (in Object Oriented approach). After that the result returned by calling getter (accessor) method related to that property will be distinct from the result returned before calling the mutator. That difference has to be persisted in the state of the program (in the object's property in that case which is mapped to a given memory address on program heap).

In procedural approach the counterpart will be altering a variable stored not on stack but on heap memory. So the change has to be permanent (persistent) not temporary (eg. global variable but not local variable). Local variables are stored on stack which is volatile and lives until a given function returns so the changes on stack are not permanent and in this case we cannot say the program state has been changed. Let's say you have a function named with a noun int factorial(int argument). You can have some local variables declared within the scope of the function (on the stack) that help you to do some computations but the changes made to these variables are gone after computation finishes and the function returns. There was no change in the state of the program in that case.

Marcin Kłopotek
  • 304
  • 1
  • 5
3

There are many naming conventions, I have not yet heard of any which follows the one you described, but anyway I am curious. The most common practice is the one described in the Clean Code book.

Usually you use Nouns for Classes and Structures (Things). You use verbs (actions) for functions or methods. And you use predicates for boolean variables returning functions. This is well explained in the book "Clean Code" in Chapter for names.

As per changing the state of the program, it can mean just as change variables in a class which changes how the program behaves. For example, if you have a class called Game which contain a variable (enum) of currentState which can have the state start_screen, game_running and end_game. Depending of the state of this class, the program changes its behavior.

pietromenna
  • 1,148
  • 5
  • 10
  • A convention like that might make sense in a language without support for properties, where you could use `size()` as the getter of the size. – CodesInChaos Feb 24 '16 at 13:07
  • please check http://stackoverflow.com/a/1991341/1088314 http://programmers.stackexchange.com/a/184867/217771. Both @CarlSmotricz and kevincline suggest it. – Sachin Divekar Feb 24 '16 at 13:28
  • Good! I also agree that in some cases when naming some accessible variables it is possible to use nouns for functions which just return the state (as the example of remainingBatteryCharge) – pietromenna Feb 24 '16 at 13:37