Download as PDF, PPTX
![People will be using the words you
choose in their conversation for the
next 20 years. You want to be sure
you do it right.
Unfortunately, many people get all
formal [...]. Just calling it what it is
isn't enough.](https://image.slidesharecdn.com/givingcodeagoodname-170726102837/85/Giving-Code-a-Good-Name-21-320.jpg)
![[TestFixture]
public class StackTests
{
[Test]
public void TestConstructor()
[Test]
public void TestDepth()
[Test]
public void TestTop()
[Test]
public void TestPush()
[Test]
public void TestPop()
}](https://image.slidesharecdn.com/givingcodeagoodname-170726102837/85/Giving-Code-a-Good-Name-62-320.jpg)
![[TestFixture]
public class StackTests
{
[Test]
public void Constructor()
[Test]
public void Depth()
[Test]
public void Top()
[Test]
public void Push()
[Test]
public void Pop()
}](https://image.slidesharecdn.com/givingcodeagoodname-170726102837/85/Giving-Code-a-Good-Name-63-320.jpg)
![[TestFixture]
public class StackTests
{
[Test]
public void Depth()
[Test]
public void Top()
[Test]
public void Push()
[Test]
public void Pop()
}](https://image.slidesharecdn.com/givingcodeagoodname-170726102837/85/Giving-Code-a-Good-Name-66-320.jpg)
![namespace Stack_spec
{
[TestFixture]
public class A_new_stack
{
[Test]
public void has_no_depth()
}
[TestFixture]
public class An_empty_stack
{
[Test]
public void throws_when_queried_for_its_top_item()
[Test]
public void throws_when_popped()
[Test]
public void acquires_depth_by_retaining_a_pushed_item_as_its_top()
}
[TestFixture]
public class A_non_empty_stack
{
[Test]
public void becomes_deeper_by_retaining_a_pushed_item_as_its_top()
[Test]
public void on_popping_reveals_tops_in_reverse_order_of_pushing()
}
}](https://image.slidesharecdn.com/givingcodeagoodname-170726102837/85/Giving-Code-a-Good-Name-68-320.jpg)
![namespace Stack_spec
{
[TestFixture]
public class A_new_stack
{
[Test]
public void has_no_depth()
}
[TestFixture]
public class An_empty_stack
{
[Test]
public void throws_when_queried_for_its_top_item()
[Test]
public void throws_when_popped()
[Test]
public void acquires_depth_by_retaining_a_pushed_item_as_its_top()
}
[TestFixture]
public class A_non_empty_stack
{
[Test]
public void becomes_deeper_by_retaining_a_pushed_item_as_its_top()
[Test]
public void on_popping_reveals_tops_in_reverse_order_of_pushing()
}
}](https://image.slidesharecdn.com/givingcodeagoodname-170726102837/85/Giving-Code-a-Good-Name-69-320.jpg)
Uploaded byKevlin Henney
Giving Code a Good Name
The document emphasizes the importance of using meaningful names in code to enhance readability and understanding, arguing that clear identifiers can reduce the time spent deciphering code. It discusses the role of comments, cautioning against their overuse in favor of self-explanatory code. Additionally, it touches on the principle that tests should specify required functionality, implying that clarity in coding and testing practices is essential for effective software development.
More Related Content
Similar to Giving Code a Good Name
![A Primer on High-Quality Identifier Naming [ASE 2022]](https://cdn.slidesharecdn.com/ss_thumbnails/tutorialidentifiernaming-221010194443-15a389e4-thumbnail.jpg?width=640&height=640&fit=bounds)
Giving Code a Good Name
- 1. Giving Code a GoodName @KevlinHenney
- 4.
- 5.
- 6.
- 7.
- 8. code, noun ▪ aset of instructions for a computer ▪ a computer program, or a portion thereof ▪ a system of words, figures or symbols used to represent others, especially for the purposes of secrecy ▪ a set of conventions or principles governing behaviour or activity in a particular domain Concise Oxford English Dictionary ∙ Oxford English Dictionary ∙ Merriam-Webster's Collegiate Dictionary
- 9. As a I want Sothat $Role $Feature $Benefit
- 10. As a I want Sothat programmer $Feature $Benefit
- 11. As a I want Sothat programmer good identifier names $Benefit
- 12. As a I want Sothat programmer good identifier names I can read code
- 13. As a I want Sothat programmer good identifier names I can read and understand code
- 14. As a I want Sothat programmer good identifier names I can spend less time determining the meaning of code and more time coding meaningfully
- 15. As a I want Sothat programmer ??? I can spend less time determining the meaning of code and more time coding meaningfully
- 16. Signal-to-noise ratio (oftenabbreviated SNR or S/N) is a measure used in science and engineering that compares the level of a desired signal to the level of background noise. Signal-to-noise ratio is sometimes used informally to refer to the ratio of useful information to false or irrelevant data in a conversation or exchange. http://en.wikipedia.org/wiki/Signal_to_noise_ratio
- 18. To be, ornot to be: that is the question: Whether 'tis nobler in the mind to suffer The slings and arrows of outrageous fortune, Or to take arms against a sea of troubles, And by opposing end them? William Shakespeare Hamlet
- 19. Continuing existence orcessation of existence: those are the scenarios. Is it more empowering mentally to work towards an accommodation of the downsizings and negative outcomes of adversarial circumstance, or would it be a greater enhancement of the bottom line to move forwards to a challenge to our current difficulties, and, by making a commitment to opposition, to effect their demise? Tom Burton Long Words Bother Me
- 21. People will beusing the words you choose in their conversation for the next 20 years. You want to be sure you do it right. Unfortunately, many people get all formal [...]. Just calling it what it is isn't enough.
- 22.
- 23.
- 24. They have totack on a flowery, computer science-y, impressive sounding, but ultimately meaningless word, like Object, Thing, Component, Part, Manager, Entity, or Item.
- 25. Comments A delicate matter,requiring taste and judgement. I tend to err on the side of eliminating comments, for several reasons. First, if the code is clear, and uses good type names and variable names, it should explain itself. Second, comments aren't checked by the compiler, so there is no guarantee they're right, especially after the code is modified. A misleading comment can be very confusing. Third, the issue of typography: comments clutter code. Rob Pike, "Notes on Programming in C"
- 26. There is afamously bad comment style: i=i+1; /* Add one to i */ and there are worse ways to do it: /********************************** * * * Add one to i * * * **********************************/ i=i+1; Don't laugh now, wait until you see it in real life. Rob Pike, "Notes on Programming in C"
- 27. A common fallacyis to assume authors of incomprehensible code will somehow be able to express themselves lucidly and clearly in comments. Kevlin Henney https://twitter.com/KevlinHenney/status/381021802941906944
- 28.
- 29. if (portfolioIdsByTraderId.get(trader.getId()) .containsKey(portfolio.getId())) { ... } Dan North "Codein the Language of the Domain"
- 30. if (trader.canView(portfolio)) { ... } Dan North "Codein the Language of the Domain"
- 32. Agglutination is aprocess in linguistic morphology derivation in which complex words are formed by stringing together morphemes, each with a single grammatical or semantic meaning. Languages that use agglutination widely are called agglutinative languages. http://en.wikipedia.org/wiki/Agglutination
- 33.
- 34.
- 35.
- 36.
- 37.
- 38.
- 39.
- 40.
- 41. Omit needless words. WilliamStrunk and E B White The Elements of Style
- 46.
- 47.
- 48.
- 49.
- 50. role, noun ▪ anactor's part in a play, film, etc. ▪ a person or thing's function in a particular situation ▪ a function, part or expected behaviour performed in a particular operation or process Concise Oxford English Dictionary ∙ Merriam-Webster's Collegiate Dictionary
- 51.
- 52.
- 53.
- 54.
- 55.
- 56.
- 57.
- 58.
- 59. Everybody knows thatTDD stands for Test Driven Development. However, people too often concentrate on the words "Test" and "Development" and don't consider what the word "Driven" really implies. For tests to drive development they must do more than just test that code performs its required functionality: they must clearly express that required functionality to the reader. That is, they must be clear specifications of the required functionality. Tests that are not written with their role as specifications in mind can be very confusing to read. Nat Pryce and Steve Freeman "Are Your Tests Really Driving Your Development?"
- 61. public class Stack<T> { private public Stack() public int Depth public T Top public void Push(T newTop) public void Pop() }
- 62. [TestFixture] public class StackTests { [Test] publicvoid TestConstructor() [Test] public void TestDepth() [Test] public void TestTop() [Test] public void TestPush() [Test] public void TestPop() }
- 63. [TestFixture] public class StackTests { [Test] publicvoid Constructor() [Test] public void Depth() [Test] public void Top() [Test] public void Push() [Test] public void Pop() }
- 64. public class Stack<T> { private public Stack() public int Depth public T Top public void Push(T newTop) public void Pop() }
- 65. public class Stack<T> { private public int Depth public T Top public void Push(T newTop) public void Pop() }
- 66. [TestFixture] public class StackTests { [Test] publicvoid Depth() [Test] public void Top() [Test] public void Push() [Test] public void Pop() }
- 67.
- 68. namespace Stack_spec { [TestFixture] public classA_new_stack { [Test] public void has_no_depth() } [TestFixture] public class An_empty_stack { [Test] public void throws_when_queried_for_its_top_item() [Test] public void throws_when_popped() [Test] public void acquires_depth_by_retaining_a_pushed_item_as_its_top() } [TestFixture] public class A_non_empty_stack { [Test] public void becomes_deeper_by_retaining_a_pushed_item_as_its_top() [Test] public void on_popping_reveals_tops_in_reverse_order_of_pushing() } }
- 69. namespace Stack_spec { [TestFixture] public classA_new_stack { [Test] public void has_no_depth() } [TestFixture] public class An_empty_stack { [Test] public void throws_when_queried_for_its_top_item() [Test] public void throws_when_popped() [Test] public void acquires_depth_by_retaining_a_pushed_item_as_its_top() } [TestFixture] public class A_non_empty_stack { [Test] public void becomes_deeper_by_retaining_a_pushed_item_as_its_top() [Test] public void on_popping_reveals_tops_in_reverse_order_of_pushing() } }
- 70. As a I want Sothat programmer ??? I can spend less time determining the meaning of code and more time coding meaningfully
- 71. As a I want Sothat programmer identifiers to communicate directly and with intent I can spend less time determining the meaning of code and more time coding meaningfully
- 72. At some level thestyle becomes the substance.