{"type":"doc","content":[{"type":"panel","attrs":{"panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Tip VS6","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"It’s common for code to work with similar variables. In these cases, make sure variable names are specific enough to distinguish between those variables.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Consider 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\":\"9958ddce-0a17-41bd-9665-0502aec86db7\",\"label\":\"C++\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - .NET library terminology overlap\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Consider the following code that does something with .NET libraries:\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Names with a subtle but problematic overlap:\",\"marks\":[{\"type\":\"strong\"}]}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::vector asp_net_core_library_names;\\nstd::vector dot_net_library_names;\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Those variable names seem pretty good at first glance. However, there’s a problem - \"},{\"type\":\"text\",\"text\":\"ASP.NET Core\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/ASP.NET_Core\"}}]},{\"type\":\"text\",\"text\":\" is a subset of \"},{\"type\":\"text\",\"text\":\".NET\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/.NET\"}}]},{\"type\":\"text\",\"text\":\". That means that the names included in \"},{\"type\":\"text\",\"text\":\"asp_net_core_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" could potentially be in the \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable as well. Is that what’s intended? The name doesn’t make it clear, which means for a reader would have to spend time reading/reverse-engineering other code to figure it out.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #1: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If the \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" list is intended to also include all of the \"},{\"type\":\"text\",\"text\":\"asp_net_core_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" (even if those need to be tracked separately for some reason), then that could be made clearer by changing \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" to \"},{\"type\":\"text\",\"text\":\"all_dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\":\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::vector asp_net_core_library_names;\\nstd::vector all_dot_net_library_names;\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #2: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If instead \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is intended to hold names that are mutually exclusive with the \"},{\"type\":\"text\",\"text\":\"asp_net_core_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\", then an “other” prefix could be added in front of the \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::vector asp_net_core_library_names;\\nstd::vector other_dot_net_library_names;\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In either case, the additional specificity clues a reader into something being a bit different (and thus worth paying attention to).\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Distinguishing between variables for different commands\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Generic names re-used across multiple commands: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"This code executes multiple different commands. While a few variables are specific, many generic names are re-used across different commands, making it harder to distinguish exactly what is going on.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"constexpr int SUCCESS_RETURN_CODE = 0;\\nint return_code = std::system(\\\"g++ -c main.cpp -o main.o\\\");\\nbool command_succeeded = (SUCCESS_RETURN_CODE == return_code);\\nif (!command_succeeded)\\n{\\n return false;\\n}\\n\\nreturn_code = std::system(\\\"g++ main.o -o main.exe\\\");\\ncommand_succeeded = (SUCCESS_RETURN_CODE == return_code);\\nif (!command_succeeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"More specific names for each command are better: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Differently named variables for different commands allows more specific comprehension when reading and helps avoid potential mix-ups with variables.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"constexpr int SUCCESS_RETURN_CODE = 0;\\nint compilation_return_code = std::system(\\\"g++ -c main.cpp -o main.o\\\");\\nbool compiling_succeeded = (SUCCESS_RETURN_CODE == compilation_return_code);\\nif (!compiling_succeeded)\\n{\\n return false;\\n}\\n\\nint linking_return_code = std::system(\\\"g++ main.o -o main.exe\\\");\\nbool linking_succeeded = (SUCCESS_RETURN_CODE == linking_return_code);\\nif (!linking_succeeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C++\",\"minHeight\":1750},{\"id\":\"9cb4016e-bbfa-4ba1-94c3-50994f40ed40\",\"label\":\"C#\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - .NET library terminology overlap\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Consider the following code that does something with .NET libraries:\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Names with a subtle but problematic overlap:\",\"marks\":[{\"type\":\"strong\"}]}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"List aspNetCoreLibraryNames = new List();\\nList dotNetLibraryNames = new List();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Those variable names seem pretty good at first glance. However, there’s a problem - \"},{\"type\":\"text\",\"text\":\"ASP.NET Core\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/ASP.NET_Core\"}}]},{\"type\":\"text\",\"text\":\" is a subset of \"},{\"type\":\"text\",\"text\":\".NET\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/.NET\"}}]},{\"type\":\"text\",\"text\":\". That means that the names included in \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" could potentially be in the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable as well. Is that what’s intended? The name doesn’t make it clear, which means for a reader would have to spend time reading/reverse-engineering other code to figure it out.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #1: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" list is intended to also include all of the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" (even if those need to be tracked separately for some reason), then that could be made clearer by changing \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" to \"},{\"type\":\"text\",\"text\":\"allDotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\":\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"List aspNetCoreLibraryNames = new List();\\nList allDotNetLibraryNames = new List();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #2: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If instead \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is intended to hold names that are mutually exclusive with the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\", then an “other” prefix could be added in front of the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"List aspNetCoreLibraryNames = new List();\\nList otherDotNetLibraryNames = new List();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In either case, the additional specificity clues a reader into something being a bit different (and thus worth paying attention to).\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Distinguishing between variables for different commands\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Generic names re-used across multiple commands: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"This code executes multiple different commands. While a few variables are specific, many generic names are re-used across different commands, making it harder to distinguish exactly what is going on.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"const int SuccessReturnCode = 0;\\nProcess commandProcess = Process.Start(\\\"cmd.exe\\\", \\\"/C g++ -c main.cpp -o main.o\\\");\\ncommandProcess.WaitForExit();\\nbool commandSucceeded = (commandProcess.ExitCode == SuccessReturnCode);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\\n\\ncommandProcess = Process.Start(\\\"cmd.exe\\\", \\\"/C g++ main.o -o main.exe\\\");\\ncommandProcess.WaitForExit();\\ncommandSucceeded = (commandProcess.ExitCode == SuccessReturnCode);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"More specific names for each command are better: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Differently named variables for different commands allows more specific comprehension when reading and helps avoid potential mix-ups with variables.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"const int SuccessReturnCode = 0;\\nProcess compileProcess = Process.Start(\\\"cmd.exe\\\", \\\"/C g++ -c main.cpp -o main.o\\\");\\ncompileProcess.WaitForExit();\\nbool compilingSucceeded = (compileProcess.ExitCode == SuccessReturnCode);\\nif (!compilingSucceeded)\\n{\\n return false;\\n}\\n\\nProcess linkingProcess = Process.Start(\\\"cmd.exe\\\", \\\"/C g++ main.o -o main.exe\\\");\\nlinkingProcess.WaitForExit();\\nbool linkingSucceeded = (linkingProcess.ExitCode == SuccessReturnCode);\\nif (!linkingSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C#\",\"minHeight\":1750},{\"id\":\"934d5aaf-9304-4708-9de3-197775018a2e\",\"label\":\"Java\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - .NET library terminology overlap\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Consider the following code that does something with .NET libraries:\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Names with a subtle but problematic overlap:\",\"marks\":[{\"type\":\"strong\"}]}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"List aspNetCoreLibraryNames = new ArrayList<>();\\nList dotNetLibraryNames = new ArrayList<>();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Those variable names seem pretty good at first glance. However, there’s a problem - \"},{\"type\":\"text\",\"text\":\"ASP.NET Core\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/ASP.NET_Core\"}}]},{\"type\":\"text\",\"text\":\" is a subset of \"},{\"type\":\"text\",\"text\":\".NET\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/.NET\"}}]},{\"type\":\"text\",\"text\":\". That means that the names included in \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" could potentially be in the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable as well. Is that what’s intended? The name doesn’t make it clear, which means for a reader would have to spend time reading/reverse-engineering other code to figure it out.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #1: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" list is intended to also include all of the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" (even if those need to be tracked separately for some reason), then that could be made clearer by changing \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" to \"},{\"type\":\"text\",\"text\":\"allDotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\":\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"List aspNetCoreLibraryNames = new ArrayList<>();\\nList allDotNetLibraryNames = new ArrayList<>();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #2: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If instead \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is intended to hold names that are mutually exclusive with the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\", then an “other” prefix could be added in front of the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"List aspNetCoreLibraryNames = new ArrayList<>();\\nList otherDotNetLibraryNames = new ArrayList<>();\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In either case, the additional specificity clues a reader into something being a bit different (and thus worth paying attention to).\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Distinguishing between variables for different commands\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Generic names re-used across multiple commands: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"This code executes multiple different commands. While a few variables are specific, many generic names are re-used across different commands, making it harder to distinguish exactly what is going on.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"final int SUCCESS_RETURN_CODE = 0;\\nProcess commandProcess = Runtime.getRuntime().exec(\\\"g++ -c main.cpp -o main.o\\\");\\nint returnCode = commandProcess.waitFor();\\nboolean commandSucceeded = (returnCode == SUCCESS_RETURN_CODE);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\\n\\ncommandProcess = Runtime.getRuntime().exec(\\\"g++ main.o -o main.exe\\\");\\nreturnCode = commandProcess.waitFor();\\ncommandSucceeded = (returnCode == SUCCESS_RETURN_CODE);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"More specific names for each command are better: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Differently named variables for different commands allows more specific comprehension when reading and helps avoid potential mix-ups with variables.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"final int SUCCESS_RETURN_CODE = 0;\\nProcess compileProcess = Runtime.getRuntime().exec(\\\"g++ -c main.cpp -o main.o\\\");\\nint compileReturnCode = compileProcess.waitFor();\\nboolean compilingSucceeded = (compileReturnCode == SUCCESS_RETURN_CODE);\\nif (!compilingSucceeded)\\n{\\n return false;\\n}\\n\\nProcess linkingProcess = Runtime.getRuntime().exec(\\\"g++ main.o -o main.exe\\\");\\nint linkReturnCode = linkingProcess.waitFor();\\nboolean linkingSucceeded = (linkReturnCode == SUCCESS_RETURN_CODE);\\nif (!linkingSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Java\",\"minHeight\":1750},{\"id\":\"e5c78acb-4474-4601-8f4d-0e721595e2b9\",\"label\":\"Python\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - .NET library terminology overlap\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Consider the following code that does something with .NET libraries:\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Names with a subtle but problematic overlap:\",\"marks\":[{\"type\":\"strong\"}]}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"asp_net_core_library_names: list[str] = []\\ndot_net_library_names: list[str] = []\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Those variable names seem pretty good at first glance. However, there’s a problem - \"},{\"type\":\"text\",\"text\":\"ASP.NET Core\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/ASP.NET_Core\"}}]},{\"type\":\"text\",\"text\":\" is a subset of \"},{\"type\":\"text\",\"text\":\".NET\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/.NET\"}}]},{\"type\":\"text\",\"text\":\". That means that the names included in \"},{\"type\":\"text\",\"text\":\"asp_net_core_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" could potentially be in the \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable as well. Is that what’s intended? The name doesn’t make it clear, which means for a reader would have to spend time reading/reverse-engineering other code to figure it out.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #1: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If the \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" list is intended to also include all of the \"},{\"type\":\"text\",\"text\":\"asp_net_core_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" (even if those need to be tracked separately for some reason), then that could be made clearer by changing \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" to \"},{\"type\":\"text\",\"text\":\"all_dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\":\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"asp_net_core_library_names: list[str] = []\\nall_dot_net_library_names: list[str] = []\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #2: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If instead \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is intended to hold names that are mutually exclusive with the \"},{\"type\":\"text\",\"text\":\"asp_net_core_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\", then an “other” prefix could be added in front of the \"},{\"type\":\"text\",\"text\":\"dot_net_library_names\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"asp_net_core_library_names: list[str] = []\\nother_dot_net_library_names: list[str] = []\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In either case, the additional specificity clues a reader into something being a bit different (and thus worth paying attention to).\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Distinguishing between variables for different commands\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Generic names re-used across multiple commands: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"This code executes multiple different commands. While a few variables are specific, many generic names are re-used across different commands, making it harder to distinguish exactly what is going on.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"SUCCESS_RETURN_CODE = 0\\ncompile_command = [\\\"g++\\\", \\\"-c\\\", \\\"main.cpp\\\", \\\"-o\\\", \\\"main.o\\\"]\\ncompleted_command_process = subprocess.run(compile_command)\\ncommand_succeeded = (completed_command_process.returncode == SUCCESS_RETURN_CODE)\\nif not command_succeeded:\\n return False\\n\\nlink_command = [\\\"g++\\\", \\\"main.o\\\", \\\"-o\\\", \\\"main.exe\\\"]\\ncompleted_command_process = subprocess.run(link_command)\\ncommand_succeeded = (completed_command_process.returncode == SUCCESS_RETURN_CODE)\\nif not command_succeeded:\\n return False\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"More specific names for each command are better: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Differently named variables for different commands allows more specific comprehension when reading and helps avoid potential mix-ups with variables.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"SUCCESS_RETURN_CODE = 0\\ncompile_command = [\\\"g++\\\", \\\"-c\\\", \\\"main.cpp\\\", \\\"-o\\\", \\\"main.o\\\"]\\ncompleted_compile_process = subprocess.run(compile_command)\\ncompiling_succeeded = (completed_compile_process.returncode == SUCCESS_RETURN_CODE)\\nif not compiling_succeeded:\\n return False\\n\\nlink_command = [\\\"g++\\\", \\\"main.o\\\", \\\"-o\\\", \\\"main.exe\\\"]\\ncompleted_linking_process = subprocess.run(link_command)\\nlinking_succeeded = (completed_linking_process.returncode == SUCCESS_RETURN_CODE)\\nif not linking_succeeded:\\n return False\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Python\",\"minHeight\":1750},{\"id\":\"fbca97df-6a5e-4959-b78d-3eba4f157eb7\",\"label\":\"JavaScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - .NET library terminology overlap\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Consider the following code that does something with .NET libraries:\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Names with a subtle but problematic overlap:\",\"marks\":[{\"type\":\"strong\"}]}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let aspNetCoreLibraryNames = [];\\nlet dotNetLibraryNames = [];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Those variable names seem pretty good at first glance. However, there’s a problem - \"},{\"type\":\"text\",\"text\":\"ASP.NET Core\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/ASP.NET_Core\"}}]},{\"type\":\"text\",\"text\":\" is a subset of \"},{\"type\":\"text\",\"text\":\".NET\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/.NET\"}}]},{\"type\":\"text\",\"text\":\". That means that the names included in \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" could potentially be in the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable as well. Is that what’s intended? The name doesn’t make it clear, which means for a reader would have to spend time reading/reverse-engineering other code to figure it out.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #1: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" list is intended to also include all of the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" (even if those need to be tracked separately for some reason), then that could be made clearer by changing \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" to \"},{\"type\":\"text\",\"text\":\"allDotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\":\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let aspNetCoreLibraryNames = [];\\nlet allDotNetLibraryNames = [];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #2: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If instead \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is intended to hold names that are mutually exclusive with the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\", then an “other” prefix could be added in front of the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let aspNetCoreLibraryNames = [];\\nlet otherDotNetLibraryNames = [];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In either case, the additional specificity clues a reader into something being a bit different (and thus worth paying attention to).\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Distinguishing between variables for different commands\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Generic names re-used across multiple commands: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"This code executes multiple different commands. While a few variables are specific, many generic names are re-used across different commands, making it harder to distinguish exactly what is going on.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"const SUCCESS_RETURN_CODE = 0;\\nconst compileCommand = 'g++ -c main.cpp -o main.o';\\nlet commandResult = child_process.spawnSync(compileCommand);\\nlet commandSucceeded = (commandResult.status === SUCCESS_RETURN_CODE);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\\n\\nconst linkCommand = 'g++ main.o -o main.exe';\\ncommandResult = child_process.spawnSync(linkCommand);\\ncommandSucceeded = (commandResult.status === SUCCESS_RETURN_CODE);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"More specific names for each command are better: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Differently named variables for different commands allows more specific comprehension when reading and helps avoid potential mix-ups with variables.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"const SUCCESS_RETURN_CODE = 0;\\nconst compileCommand = 'g++ -c main.cpp -o main.o';\\nlet compileCommandResult = child_process.spawnSync(compileCommand);\\nlet compilingSucceeded = (compileCommandResult.status === SUCCESS_RETURN_CODE);\\nif (!compilingSucceeded)\\n{\\n return false;\\n}\\n\\nconst linkCommand = 'g++ main.o -o main.exe';\\nlet linkCommandResult = child_process.spawnSync(linkCommand);\\nlet linkingSucceeded = (linkCommandResult.status === SUCCESS_RETURN_CODE);\\nif (!linkingSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"JavaScript\",\"minHeight\":1750},{\"id\":\"c3f3e378-5b41-46bd-896c-c8d2d878a3cb\",\"label\":\"TypeScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - .NET library terminology overlap\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Consider the following code that does something with .NET libraries:\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Names with a subtle but problematic overlap:\",\"marks\":[{\"type\":\"strong\"}]}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let aspNetCoreLibraryNames: string[] = [];\\nlet dotNetLibraryNames: string[] = [];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Those variable names seem pretty good at first glance. However, there’s a problem - \"},{\"type\":\"text\",\"text\":\"ASP.NET Core\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/ASP.NET_Core\"}}]},{\"type\":\"text\",\"text\":\" is a subset of \"},{\"type\":\"text\",\"text\":\".NET\",\"marks\":[{\"type\":\"link\",\"attrs\":{\"href\":\"https://en.wikipedia.org/wiki/.NET\"}}]},{\"type\":\"text\",\"text\":\". That means that the names included in \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" could potentially be in the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable as well. Is that what’s intended? The name doesn’t make it clear, which means for a reader would have to spend time reading/reverse-engineering other code to figure it out.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #1: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" list is intended to also include all of the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" (even if those need to be tracked separately for some reason), then that could be made clearer by changing \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" to \"},{\"type\":\"text\",\"text\":\"allDotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\":\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let aspNetCoreLibraryNames: string[] = [];\\nlet allDotNetLibraryNames: string[] = [];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Improved names option #2: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"If instead \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is intended to hold names that are mutually exclusive with the \"},{\"type\":\"text\",\"text\":\"aspNetCoreLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\", then an “other” prefix could be added in front of the \"},{\"type\":\"text\",\"text\":\"dotNetLibraryNames\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" variable:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let aspNetCoreLibraryNames: string[] = [];\\nlet otherDotNetLibraryNames: string[] = [];\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In either case, the additional specificity clues a reader into something being a bit different (and thus worth paying attention to).\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Distinguishing between variables for different commands\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Generic names re-used across multiple commands: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"This code executes multiple different commands. While a few variables are specific, many generic names are re-used across different commands, making it harder to distinguish exactly what is going on.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"const SUCCESS_RETURN_CODE = 0;\\nconst compileCommand = 'g++ -c main.cpp -o main.o';\\nlet commandResult = child_process.spawnSync(compileCommand);\\nlet commandSucceeded = (commandResult.status === SUCCESS_RETURN_CODE);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\\n\\nconst linkCommand = 'g++ main.o -o main.exe';\\ncommandResult = child_process.spawnSync(linkCommand);\\ncommandSucceeded = (commandResult.status === SUCCESS_RETURN_CODE);\\nif (!commandSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"More specific names for each command are better: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Differently named variables for different commands allows more specific comprehension when reading and helps avoid potential mix-ups with variables.\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"const SUCCESS_RETURN_CODE = 0;\\nconst compileCommand = 'g++ -c main.cpp -o main.o';\\nlet compileCommandResult = child_process.spawnSync(compileCommand);\\nlet compilingSucceeded = (compileCommandResult.status === SUCCESS_RETURN_CODE);\\nif (!compilingSucceeded)\\n{\\n return false;\\n}\\n\\nconst linkCommand = 'g++ main.o -o main.exe';\\nlet linkCommandResult = child_process.spawnSync(linkCommand);\\nlet linkingSucceeded = (linkCommandResult.status === SUCCESS_RETURN_CODE);\\nif (!linkingSucceeded)\\n{\\n return false;\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"TypeScript\",\"minHeight\":1750}],\"design\":null,\"designType\":\"tab\",\"vertical\":false,\"showTabCard\":true,\"width\":150,\"isEmbedded\":false,\"minHeight\":1775,\"lastTabWidth\":150,\"pages\":[\"9958ddce-0a17-41bd-9665-0502aec86db7\",\"9cb4016e-bbfa-4ba1-94c3-50994f40ed40\",\"934d5aaf-9304-4708-9de3-197775018a2e\",\"e5c78acb-4474-4601-8f4d-0e721595e2b9\",\"fbca97df-6a5e-4959-b78d-3eba4f157eb7\",\"c3f3e378-5b41-46bd-896c-c8d2d878a3cb\"]},\"labeled\":{\"labels\":[]},\"childpages\":{}}"}},"macroMetadata":{"macroId":{"value":"beb31cb4-6a43-43cd-93a3-fa395f063240"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.6/images/macro-icon.png"}}],"title":"Tab Wizard"}},"localId":"a7c2bc80-c194-41db-8949-bf4a9c0ea59b"}},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":2051,"alt":"Busy coding or busy meeting ad.png","id":"aefba42a-17bf-4f60-9740-faba1e17446f","collection":"contentId-101187736","type":"file","height":550},"marks":[{"type":"link","attrs":{"href":"https://www.pulsepoint-ai.com/developers"}}]}]}],"version":1}

Make Names Specific Enough to Distinguish Between Similar Variables [VS6]