From 0c671c9827555833f0a6d3d953a23ac87d20e536 Mon Sep 17 00:00:00 2001 From: steverusso Date: Wed, 29 Jul 2020 20:42:06 -0400 Subject: [PATCH] Revert back to a code block. --- content/blog/boolean_names.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/blog/boolean_names.md b/content/blog/boolean_names.md index 6b9adcc..33061af 100644 --- a/content/blog/boolean_names.md +++ b/content/blog/boolean_names.md @@ -20,7 +20,11 @@ A boolean name should give the reader more clarity as its scope expands. A bool ## Bad Boolean Names As with many things in software engineering, it is easier to find mistakes than to do something correctly the first time. Here are some naming conventions to avoid: 1. Names that are already a negation. 'featureTurnedOff' and 'notProd' may make sense in one use case, but they become confusing in a larger context. The following code is both hard to read and ambiguous (what if there is a third environment). -

confA.useProd := !confB.notProd

+ ```go + + confA.useProd := !confB.notProd + + ``` 2. Names that are not negatable. A name such as 'sheets' has ambiguous meaning. It probably has something to do with a spreadsheet, but it is the writer's responsibility to prevent the reader from needing to do an investigation.