{"type":"doc","content":[{"type":"panel","attrs":{"panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Tip VP3","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Avoid extraneous solution domain suffixes on variable names unless absolutely necessary to provide meaningful distinctions with surrounding code. A common issue is adding exact data type names to variable names.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"See the following examples:","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"navitabs-tab-wizard","parameters":{"macroParams":{"__bodyContent":{"value":"{\"type\":\"custom\",\"custom\":{\"tabs\":[{\"id\":\"c3961700-aab1-466e-8461-3c31352819ce\",\"value\":\"C++\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Unnecessary “List” or “Array” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Including exact data type (“list” or “array”) in the variable name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::list cpp_compiler_options_list = \\n{\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n};\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"While “lists” don’t have to be solution domain concepts (plenty of “lists” exist out in the real-world), inclusion of suffixes like this in variable names is typically more indicative of some programming data type (and even if not, is often an unnecessary word for people to read) and thus is best avoided.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Orienting the variable name more in the problem domain - just a plural list of compiler options:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::list cpp_compiler_options = \\n{\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n};\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Unnecessary “Set” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"set\\\" in this name is referring to the programming \\\"set\\\" data type.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::set index_names_set = { \\\"index1\\\", \\\"index2\\\" };\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Focuses on the problem of representing multiple index names. \\\"unique\\\" has been added as an alternative way to communicate that the index names are expected to be unique, but that prefix may not be necessary in all circumstances.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::set unique_index_names = { \\\"index1\\\", \\\"index2\\\" };\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Unnecessary “Object” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" unnecessarily referring to programming language notion of an object.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"NavigationMenu navigation_menu_object;\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" has been removed.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"NavigationMenu navigation_menu;\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Unnecessary “Field Value” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"Field value\\\" is appended to each member variable name. All member variables are considered \\\"fields,\\\" so such terminology is unnecessarily redundant.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"struct LogRecord\\n{\\n DateTime UtcDateTimeFieldValue = {};\\n std::string MessageFieldValue = \\\"\\\";\\n};\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Member variable names focus on the problem domain data they hold.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"struct LogRecord\\n{\\n DateTime UtcDateTime = {};\\n std::string Message = \\\"\\\";\\n};\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"type\":\"your-content\"},{\"id\":\"87c1a862-726c-4033-88b6-d7b6acc3dc69\",\"value\":\"C#\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Unnecessary “List” or “Array” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Including exact data type (“list” or “array”) in the variable name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"List cppCompilerOptionsList = new List\\n{\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n};\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"While “lists” don’t have to be solution domain concepts (plenty of “lists” exist out in the real-world), inclusion of suffixes like this in variable names is typically more indicative of some programming data type (and even if not, is often an unnecessary word for people to read) and thus is best avoided.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Orienting the variable name more in the problem domain - just a plural list of compiler options:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"List cppCompilerOptions = new List\\n{\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n};\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Unnecessary “Set” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"set\\\" in this name is referring to the programming \\\"set\\\" data type.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"HashSet indexNamesSet = new HashSet { \\\"index1\\\", \\\"index2\\\" };\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Focuses on the problem of representing multiple index names. \\\"unique\\\" has been added as an alternative way to communicate that the index names are expected to be unique, but that prefix may not be necessary in all circumstances.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"HashSet uniqueIndexNames = new HashSet { \\\"index1\\\", \\\"index2\\\" };\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Unnecessary “Object” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" unnecessarily referring to programming language notion of an object.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"NavigationMenu navigationMenuObject = new NavigationMenu();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" has been removed.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"NavigationMenu navigationMenu = new NavigationMenu();\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Unnecessary “Field Value” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"Field value\\\" is appended to each member variable name. All member variables are considered \\\"fields,\\\" so such terminology is unnecessarily redundant.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"public class LogRecord\\n{\\n public DateTime UtcDateTimeFieldValue { get; set; } = DateTime.MinValue;\\n public string MessageFieldValue { get; set; } = \\\"\\\";\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Member variable names focus on the problem domain data they hold.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"public class LogRecord\\n{\\n public DateTime UtcDateTime { get; set; } = DateTime.MinValue;\\n public string Message { get; set; } = \\\"\\\";\\n}\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 5 - Unnecessary “Instances” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Unnecessarily refers to \\\"instances\\\" of objects in a programming language.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"Regex matchDoubleQuotesRegex = new Regex(\\\"\\\\\\\"\\\");\\nMatchCollection doubleQuoteMatchInstances = matchDoubleQuotesRegex.Matches(text);\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Focuses on the core problem domain concept of \\\"matches\\\" being made in text.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"Regex matchDoubleQuotesRegex = new Regex(\\\"\\\\\\\"\\\");\\nMatchCollection doubleQuoteMatches = matchDoubleQuotesRegex.Matches(text);\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"type\":\"your-content\"},{\"id\":\"6326e3fa-9c0f-4268-8179-b6106fcabe29\",\"value\":\"Java\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Unnecessary “List” or “Array” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Including exact data type (“list” or “array”) in the variable name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"List cppCompilerOptionsList = List.of(\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n);\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"While “lists” don’t have to be solution domain concepts (plenty of “lists” exist out in the real-world), inclusion of suffixes like this in variable names is typically more indicative of some programming data type (and even if not, is often an unnecessary word for people to read) and thus is best avoided.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Orienting the variable name more in the problem domain - just a plural list of compiler options:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"List cppCompilerOptions = List.of(\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n);\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Unnecessary “Set” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"set\\\" in this name is referring to the programming \\\"set\\\" data type.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"Set indexNamesSet = new HashSet();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Focuses on the problem of representing multiple index names. \\\"unique\\\" has been added as an alternative way to communicate that the index names are expected to be unique, but that prefix may not be necessary in all circumstances.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"Set uniqueIndexNames = new HashSet();\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Unnecessary “Object” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" unnecessarily referring to programming language notion of an object.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"NavigationMenu navigationMenuObject = new NavigationMenu();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" has been removed.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"NavigationMenu navigationMenu = new NavigationMenu();\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Unnecessary “Field Value” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"Field value\\\" is appended to each member variable name. All member variables are considered \\\"fields,\\\" so such terminology is unnecessarily redundant.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"public class LogRecord\\n{\\n public Instant utcDateTimeFieldValue;\\n public String messageFieldValue;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Member variable names focus on the problem domain data they hold.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"public class LogRecord\\n{\\n public Instant utcDateTime;\\n public String message;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"type\":\"your-content\"},{\"id\":\"8caf241f-665e-466e-a888-2ad20ec41966\",\"value\":\"Python\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Unnecessary “List” or “Array” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Including exact data type (“list” or “array”) in the variable name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"cpp_compiler_options_list: list[str] = [\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\", \\\"output_program\\\"\\n]\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"While “lists” don’t have to be solution domain concepts (plenty of “lists” exist out in the real-world), inclusion of suffixes like this in variable names is typically more indicative of some programming data type (and even if not, is often an unnecessary word for people to read) and thus is best avoided.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Orienting the variable name more in the problem domain - just a plural list of compiler options:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"cpp_compiler_options: list[str] = [\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\", \\\"output_program\\\"\\n]\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Unnecessary “Set” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"set\\\" in this name is referring to the programming \\\"set\\\" data type.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"index_names_set: set[str] = { \\\"index1\\\", \\\"index2\\\" }\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Focuses on the problem of representing multiple index names. \\\"unique\\\" has been added as an alternative way to communicate that the index names are expected to be unique, but that prefix may not be necessary in all circumstances.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"unique_index_names: set[str] = { \\\"index1\\\", \\\"index2\\\" }\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Unnecessary “Object” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" unnecessarily referring to programming language notion of an object.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"navigation_menu_object = NavigationMenu()\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" has been removed.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"navigation_menu = NavigationMenu()\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Unnecessary “Field Value” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"Field value\\\" is appended to each member variable name. All member variables are considered \\\"fields,\\\" so such terminology is unnecessarily redundant.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"@dataclass\\nclass LogRecord:\\n utc_date_time_field_value: datetime = dataclasses.MISSING\\n message_field_value: str = \\\"\\\"\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Member variable names focus on the problem domain data they hold.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"@dataclass\\nclass LogRecord:\\n utc_date_time: datetime = dataclasses.MISSING\\n message: str = \\\"\\\"\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"type\":\"your-content\"},{\"id\":\"c26e1920-0a45-438d-bfd2-a504145fefec\",\"value\":\"JavaScript\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Unnecessary “List” or “Array” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Including exact data type (“list” or “array”) in the variable name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let cppCompilerOptionsArray = [\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"While “lists” don’t have to be solution domain concepts (plenty of “lists” exist out in the real-world), inclusion of suffixes like this in variable names is typically more indicative of some programming data type (and even if not, is often an unnecessary word for people to read) and thus is best avoided.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Orienting the variable name more in the problem domain - just a plural list of compiler options:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let cppCompilerOptions = [\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n];\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Unnecessary “Set” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"set\\\" in this name is referring to the programming \\\"set\\\" data type.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let indexNamesSet = new Set([\\\"index1\\\", \\\"index2\\\"]);\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Focuses on the problem of representing multiple index names. \\\"unique\\\" has been added as an alternative way to communicate that the index names are expected to be unique, but that prefix may not be necessary in all circumstances.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let uniqueIndexNames = new Set([\\\"index1\\\", \\\"index2\\\"]);\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Unnecessary “Object” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" unnecessarily referring to programming language notion of an object.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let navigationMenuObject = new NavigationMenu();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" has been removed.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let navigationMenu = new NavigationMenu();\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Unnecessary “Field Value” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"Field value\\\" is appended to each member variable name. All member variables are considered \\\"fields,\\\" so such terminology is unnecessarily redundant.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"class LogRecord\\n{\\n utcDateTimeFieldValue;\\n messageFieldValue;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Member variable names focus on the problem domain data they hold.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"class LogRecord\\n{\\n utcDateTime;\\n message;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"type\":\"your-content\"},{\"id\":\"0f7500a6-9eac-4a9c-a1a3-13828301fdbb\",\"value\":\"TypeScript\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Unnecessary “List” or “Array” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Including exact data type (“list” or “array”) in the variable name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let cppCompilerOptionsArray: string[] = [\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"While “lists” don’t have to be solution domain concepts (plenty of “lists” exist out in the real-world), inclusion of suffixes like this in variable names is typically more indicative of some programming data type (and even if not, is often an unnecessary word for people to read) and thus is best avoided.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Orienting the variable name more in the problem domain - just a plural list of compiler options:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let cppCompilerOptions: string[] = [\\n \\\"-std=c++17\\\",\\n \\\"-Wall\\\",\\n \\\"-O2\\\",\\n \\\"-g\\\",\\n \\\"-o\\\",\\n \\\"output_program\\\"\\n];\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Unnecessary “Set” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"set\\\" in this name is referring to the programming \\\"set\\\" data type.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let indexNamesSet: Set = new Set([\\\"index1\\\", \\\"index2\\\"]);\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Focuses on the problem of representing multiple index names. \\\"unique\\\" has been added as an alternative way to communicate that the index names are expected to be unique, but that prefix may not be necessary in all circumstances.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let uniqueIndexNames: Set = new Set([\\\"index1\\\", \\\"index2\\\"]);\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Unnecessary “Object” Suffix\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" unnecessarily referring to programming language notion of an object.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let navigationMenuObject: NavigationMenu = new NavigationMenu();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"object\\\" has been removed.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let navigationMenu: NavigationMenu = new NavigationMenu();\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Unnecessary “Field Value” Suffixes\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"\\\"Field value\\\" is appended to each member variable name. All member variables are considered \\\"fields,\\\" so such terminology is unnecessarily redundant.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"class LogRecord\\n{\\n utcDateTimeFieldValue: Date;\\n messageFieldValue: string;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Member variable names focus on the problem domain data they hold.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"class LogRecord\\n{\\n utcDateTime: Date;\\n message: string;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"type\":\"your-content\"}],\"design\":null,\"minHeight\":0,\"vertical\":false,\"isEmbedded\":false}}"}},"macroMetadata":{"macroId":{"value":"eedae8e1-cb4a-48d5-9349-a20adbf8ac37"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/3.2.5/images/macro-icon.png"}}],"title":"Tab Wizard"}},"localId":"a1e9d94a-fbf7-41bf-8c16-8352425262f8"}},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":2051,"alt":"Busy coding or busy meeting ad.png","id":"618edb0c-24a8-4efe-82f7-3d0c1cf553f0","collection":"contentId-101220445","type":"file","height":550},"marks":[{"type":"link","attrs":{"href":"https://www.pulsepoint-ai.com/developers"}}]}]}],"version":1}

Exclude Unnecessary Solution Domain Suffixes [VP3]

Related content