{"type":"doc","content":[{"type":"panel","attrs":{"panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Tip DP10","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"In many cases, changing a hardcoded value might easily break something. Make sure comments provide safety nets to prevent a well-intentioned programmer from changing the code in a way that breaks something important.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"See examples below:","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\":\"cd6f4187-07bb-4cb3-a5da-464c72e92f43\",\"label\":\"C++\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Different Software Versions Breaking Code\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Upgrading third-party software is often desirable, but sometimes a new version has a breaking, incompatible change for your code. In such cases, you don’t want someone to try changing software versions without making sure the incompatibility has been fixed. Comments can provide this safety net:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"// Upgrading to the newer 15.2.5 compiler version broke some C++ template code,\\n// so we had to stick with an older version until the bug is fixed\\n// (https://compiler.com/bugs/1234).\\nconst std::string COMPILER_VERSION_NUMBER = \\\"15.2.4\\\";\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Values Important for Correct UI\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In user-interface code, specific values such as spacing, sizes, colors, etc. can be crucial for overcoming odd quirks and providing a great user experience. Make sure these values are clearly documented so that the UI isn’t broken upon future updates:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"// This padding is needed to prevent jitter when the user enters a search term.\\n// Less padding was insufficient, and more padding would result in wasted space.\\nconstexpr std::size_t SEARCH_BAR_PADDING_IN_PIXELS = 12;\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Important Git Command Line Arguments\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::vector git_show_command = \\n{\\n \\\"git\\\",\\n \\\"show\\\",\\n // The empty pretty format removes extraneous header\\n // info that would complicate parsing.\\n \\\"--pretty=\\\",\\n // Restricting output to only filepaths removes diff\\n // output that would also complicate parsing.\\n \\\"--name-only\\\",\\n commit_hash\\n};\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Important Compiler Options\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments, even when in variables separate from the command itself:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"std::vector compiler_options = \\n{\\n \\\"cl.exe\\\",\\n // This exception handling model is needed based on libraries we link against.\\n \\\"/EHsc\\\",\\n // This warning level is the maximum we can feasible use.\\n // While the \\\"all\\\" warning level would theoretically be desirable,\\n // it causes too much noise.\\n \\\"/W4\\\",\\n // Our code uses some of the latest C++ features.\\n \\\"/std:c++latest\\\",\\n};\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 5 - A Series of Values\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"It is common to need to populate numerous fields in some kind of data structure. Make sure it’s clear why some values are set the way they are:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"BITMAPINFO bitmap_info = {};\\nbitmap_info.bmiHeader.biSize = sizeof(bitmap_info.bmiHeader);\\nbitmap_info.bmiHeader.biWidth = render_target_width;\\n// To ensure that the bitmap for the render target has an origin\\n// at the top-left corner, the height needs to be made negative\\n// to ensure the device independent bitmap is top-down.\\nbitmap_info.bmiHeader.biHeight = -1 * render_target_height;\\n// The number of planes must always be 1.\\nbitmap_info.bmiHeader.biPlanes = 1;\\n// The pixel format is a 32-bit RGB format.\\nbitmap_info.bmiHeader.biBitCount = 32;\\nbitmap_info.bmiHeader.biCompression = BI_RGB;\\n// BI_RGB bitmaps can set the image size to 0.\\nbitmap_info.bmiHeader.biSizeImage = 0;\\n// Meter-based information (used for devices like printing) is not\\n// known or needed.\\nbitmap_info.bmiHeader.biXPelsPerMeter = 0;\\nbitmap_info.bmiHeader.biYPelsPerMeter = 0;\\n// Require all colors be supported by the bitmap.\\nbitmap_info.bmiHeader.biClrUsed = 0;\\nbitmap_info.bmiHeader.biClrImportant = 0;\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C++\",\"minHeight\":2200},{\"id\":\"5dc9c206-a01b-44a0-90b4-aa4e04535721\",\"label\":\"C#\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Different Software Versions Breaking Code\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Upgrading third-party software is often desirable, but sometimes a new version has a breaking, incompatible change for your code. In such cases, you don’t want someone to try changing software versions without making sure the incompatibility has been fixed. Comments can provide this safety net:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"// Upgrading to the newer 15.2.5 compiler version broke some C++ template code,\\n// so we had to stick with an older version until the bug is fixed\\n// (https://compiler.com/bugs/1234).\\nconst string CompilerVersionNumber = \\\"15.2.4\\\";\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Values Important for Correct UI\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In user-interface code, specific values such as spacing, sizes, colors, etc. can be crucial for overcoming odd quirks and providing a great user experience. Make sure these values are clearly documented so that the UI isn’t broken upon future updates:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"// This padding is needed to prevent jitter when the user enters a search term.\\n// Less padding was insufficient, and more padding would result in wasted space.\\nconst int SearchBarPaddingInPixels = 12;\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Important Git Command Line Arguments\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"List gitShowCommand = new List\\n{\\n \\\"git\\\",\\n \\\"show\\\",\\n // The empty pretty format removes extraneous header\\n // info that would complicate parsing.\\n \\\"--pretty=\\\",\\n // Restricting output to only filepaths removes diff\\n // output that would also complicate parsing.\\n \\\"--name-only\\\",\\n commitHash\\n};\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Important Compiler Options\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments, even when in variables separate from the command itself:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"List compilerOptions = new List\\n{\\n \\\"cl.exe\\\",\\n // This exception handling model is needed based on libraries we link against.\\n \\\"/EHsc\\\",\\n // This warning level is the maximum we can feasible use.\\n // While the \\\"all\\\" warning level would theoretically be desirable,\\n // it causes too much noise.\\n \\\"/W4\\\",\\n // Our code uses some of the latest C++ features.\\n \\\"/std:c++latest\\\",\\n};\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C#\",\"minHeight\":2200},{\"id\":\"454544ea-2eaa-407f-85dc-21bfb97d3cac\",\"label\":\"Java\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Different Software Versions Breaking Code\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Upgrading third-party software is often desirable, but sometimes a new version has a breaking, incompatible change for your code. In such cases, you don’t want someone to try changing software versions without making sure the incompatibility has been fixed. Comments can provide this safety net:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"// Upgrading to the newer 15.2.5 compiler version broke some C++ template code,\\n// so we had to stick with an older version until the bug is fixed\\n// (https://compiler.com/bugs/1234).\\nfinal String COMPILER_VERSION_NUMBER = \\\"15.2.4\\\";\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Values Important for Correct UI\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In user-interface code, specific values such as spacing, sizes, colors, etc. can be crucial for overcoming odd quirks and providing a great user experience. Make sure these values are clearly documented so that the UI isn’t broken upon future updates:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"// This padding is needed to prevent jitter when the user enters a search term.\\n// Less padding was insufficient, and more padding would result in wasted space.\\nfinal int SEARCH_BAR_PADDING_IN_PIXELS = 12;\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Important Git Command Line Arguments\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"List gitShowCommand = new ArrayList<>();\\ngitShowCommand.add(\\\"git\\\");\\ngitShowCommand.add(\\\"show\\\");\\n// The empty pretty format removes extraneous header\\n// info that would complicate parsing.\\ngitShowCommand.add(\\\"--pretty=\\\");\\n// Restricting output to only filepaths removes diff\\n// output that would also complicate parsing.\\ngitShowCommand.add(\\\"--name-only\\\");\\ngitShowCommand.add(commit_hash);\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Important Compiler Options\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments, even when in variables separate from the command itself:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"List compilerOptions = new ArrayList<>();\\ncompilerOptions.add(\\\"cl.exe\\\");\\n// This exception handling model is needed based on libraries we link against.\\ncompilerOptions.add(\\\"/EHsc\\\");\\n// This warning level is the maximum we can feasible use.\\n// While the \\\"all\\\" warning level would theoretically be desirable,\\n// it causes too much noise.\\ncompilerOptions.add(\\\"/W4\\\");\\n// Our code uses some of the latest C++ features.\\ncompilerOptions.add(\\\"/std:c++latest\\\");\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Java\",\"minHeight\":2200},{\"id\":\"fc0f19f8-457a-46fe-8cee-08d6f7e690fb\",\"label\":\"Python\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Different Software Versions Breaking Code\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Upgrading third-party software is often desirable, but sometimes a new version has a breaking, incompatible change for your code. In such cases, you don’t want someone to try changing software versions without making sure the incompatibility has been fixed. Comments can provide this safety net:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"# Upgrading to the newer 15.2.5 compiler version broke some C++ template code,\\n# so we had to stick with an older version until the bug is fixed\\n# (https://compiler.com/bugs/1234).\\nCOMPILER_VERSION_NUMBER: str = \\\"15.2.4\\\"\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Values Important for Correct UI\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In user-interface code, specific values such as spacing, sizes, colors, etc. can be crucial for overcoming odd quirks and providing a great user experience. Make sure these values are clearly documented so that the UI isn’t broken upon future updates:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"# This padding is needed to prevent jitter when the user enters a search term.\\n# Less padding was insufficient, and more padding would result in wasted space.\\nSEARCH_BAR_PADDING_IN_PIXELS: int = 12\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Important Git Command Line Arguments\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"git_show_command: list[str] = [\\n \\\"git\\\",\\n \\\"show\\\",\\n # The empty pretty format removes extraneous header\\n # info that would complicate parsing.\\n \\\"--pretty=\\\",\\n # Restricting output to only filepaths removes diff\\n # output that would also complicate parsing.\\n \\\"--name-only\\\",\\n commit_hash\\n]\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Important Compiler Options\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments, even when in variables separate from the command itself:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"compiler_options: list[str] = [\\n \\\"cl.exe\\\",\\n # This exception handling model is needed based on libraries we link against.\\n \\\"/EHsc\\\",\\n # This warning level is the maximum we can feasible use.\\n # While the \\\"all\\\" warning level would theoretically be desirable,\\n # it causes too much noise.\\n \\\"/W4\\\",\\n # Our code uses some of the latest C++ features.\\n \\\"/std:c++latest\\\",\\n]\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Python\",\"minHeight\":2200},{\"id\":\"8a71894e-979c-4ad1-8dae-a4fe073f2cc0\",\"label\":\"JavaScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Different Software Versions Breaking Code\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Upgrading third-party software is often desirable, but sometimes a new version has a breaking, incompatible change for your code. In such cases, you don’t want someone to try changing software versions without making sure the incompatibility has been fixed. Comments can provide this safety net:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"// Upgrading to the newer 15.2.5 compiler version broke some C++ template code,\\n// so we had to stick with an older version until the bug is fixed\\n// (https://compiler.com/bugs/1234).\\nconst COMPILER_VERSION_NUMBER = \\\"15.2.4\\\";\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Values Important for Correct UI\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In user-interface code, specific values such as spacing, sizes, colors, etc. can be crucial for overcoming odd quirks and providing a great user experience. Make sure these values are clearly documented so that the UI isn’t broken upon future updates:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"// This padding is needed to prevent jitter when the user enters a search term.\\n// Less padding was insufficient, and more padding would result in wasted space.\\nconst SEARCH_BAR_PADDING_IN_PIXELS = 12;\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Important Git Command Line Arguments\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"const gitShowCommand = [\\n \\\"git\\\",\\n \\\"show\\\",\\n // The empty pretty format removes extraneous header\\n // info that would complicate parsing.\\n \\\"--pretty=\\\",\\n // Restricting output to only filepaths removes diff\\n // output that would also complicate parsing.\\n \\\"--name-only\\\",\\n commitHash\\n];\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Important Compiler Options\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments, even when in variables separate from the command itself:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"let compilerOptions = [\\n \\\"cl.exe\\\",\\n // This exception handling model is needed based on libraries we link against.\\n \\\"/EHsc\\\",\\n // This warning level is the maximum we can feasible use.\\n // While the \\\"all\\\" warning level would theoretically be desirable,\\n // it causes too much noise.\\n \\\"/W4\\\",\\n // Our code uses some of the latest C++ features.\\n \\\"/std:c++latest\\\",\\n];\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"JavaScript\",\"minHeight\":2200},{\"id\":\"3645ae81-29d0-4b2a-915f-382735e51f57\",\"label\":\"TypeScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 1 - Different Software Versions Breaking Code\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Upgrading third-party software is often desirable, but sometimes a new version has a breaking, incompatible change for your code. In such cases, you don’t want someone to try changing software versions without making sure the incompatibility has been fixed. Comments can provide this safety net:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"// Upgrading to the newer 15.2.5 compiler version broke some C++ template code,\\n// so we had to stick with an older version until the bug is fixed\\n// (https://compiler.com/bugs/1234).\\nconst COMPILER_VERSION_NUMBER: string = \\\"15.2.4\\\";\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 2 - Values Important for Correct UI\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"In user-interface code, specific values such as spacing, sizes, colors, etc. can be crucial for overcoming odd quirks and providing a great user experience. Make sure these values are clearly documented so that the UI isn’t broken upon future updates:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"// This padding is needed to prevent jitter when the user enters a search term.\\n// Less padding was insufficient, and more padding would result in wasted space.\\nconst SEARCH_BAR_PADDING_IN_PIXELS: number = 12;\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 3 - Important Git Command Line Arguments\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"const gitShowCommand: string[] = [\\n \\\"git\\\",\\n \\\"show\\\",\\n // The empty pretty format removes extraneous header\\n // info that would complicate parsing.\\n \\\"--pretty=\\\",\\n // Restricting output to only filepaths removes diff\\n // output that would also complicate parsing.\\n \\\"--name-only\\\",\\n commitHash\\n];\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"Example 4 - Important Compiler Options\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Executing commands with intentionally-chosen command line arguments can be a common task for code. To make sure maintenance programmers don’t have to reverse engineer why they’re chosen, comment on any important arguments, even when in variables separate from the command itself:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"let compilerOptions: string[] = [\\n \\\"cl.exe\\\",\\n // This exception handling model is needed based on libraries we link against.\\n \\\"/EHsc\\\",\\n // This warning level is the maximum we can feasible use.\\n // While the \\\"all\\\" warning level would theoretically be desirable,\\n // it causes too much noise.\\n \\\"/W4\\\",\\n // Our code uses some of the latest C++ features.\\n \\\"/std:c++latest\\\",\\n];\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"TypeScript\",\"minHeight\":2200}],\"design\":null,\"designType\":\"tab\",\"vertical\":false,\"showTabCard\":true,\"width\":150,\"isEmbedded\":false,\"minHeight\":2250,\"lastTabWidth\":150,\"pages\":[\"cd6f4187-07bb-4cb3-a5da-464c72e92f43\",\"5dc9c206-a01b-44a0-90b4-aa4e04535721\",\"454544ea-2eaa-407f-85dc-21bfb97d3cac\",\"fc0f19f8-457a-46fe-8cee-08d6f7e690fb\",\"8a71894e-979c-4ad1-8dae-a4fe073f2cc0\",\"3645ae81-29d0-4b2a-915f-382735e51f57\"]},\"labeled\":{\"labels\":[]},\"childpages\":{}}"}},"macroMetadata":{"macroId":{"value":"0d11ffda-55ff-43ba-ac97-079b7a480770"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Wizard"}},"localId":"240d7ed3-eaf8-4d16-96e4-734112ee0b85"}},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":959,"alt":"Reclaim your coding time reduce meetings ad.png","id":"4906a957-758e-4c91-a08f-a2dc7ee8e6ff","collection":"contentId-104824833","type":"file","height":122},"marks":[{"type":"link","attrs":{"href":"https://www.pulsepoint-ai.com/developers"}}]}]}],"version":1}

Comment on Values Important for Correctness [DP10] [WHY]