{"type":"doc","content":[{"type":"panel","attrs":{"panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Tip VD2","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"When naming loop indices, clarify the kind of data that is being iterated over.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Even if you avoid overly-short single-letter loop, generic names like ","type":"text"},{"text":"index","type":"text","marks":[{"type":"code"}]},{"text":" can still be problematic:","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\":\"f084105e-f3ab-4640-bb92-5393cb166695\",\"label\":\"C++\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Loop index variable with a very generic name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"for (int index = 0; index < entry_count; ++index)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Imagine you’re iterating over characters or words. Whether or not the element at \"},{\"type\":\"text\",\"text\":\"index\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is a character or word can make a big difference.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"You can clarify exactly what is being indexed into by making the loop index variable names contain that information:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"for (int character_index = 0; character_index < character_count; ++character_index)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"That would make code like \"},{\"type\":\"text\",\"text\":\"words[character_index]\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" clearly look wrong - the wrong kind of index is used to lookup a word.\"}]}]},\"fullName\":\"C++\",\"minHeight\":0},{\"id\":\"9d248694-90d1-47bc-8ad5-7ae0a8890d44\",\"label\":\"C#\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Loop index variable with a very generic name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"for (int index = 0; index < entryCount; ++index)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Imagine you’re iterating over characters or words. Whether or not the element at \"},{\"type\":\"text\",\"text\":\"index\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is a character or word can make a big difference.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"You can clarify exactly what is being indexed into by making the loop index variable names contain that information:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"for (int characterIndex = 0; characterIndex < characterCount; ++characterIndex)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"That would make code like \"},{\"type\":\"text\",\"text\":\"words[character_index]\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" clearly look wrong - the wrong kind of index is used to lookup a word.\"}]}]},\"fullName\":\"C#\",\"minHeight\":0},{\"id\":\"2d94fa26-ae2f-458c-8026-fdd41c71d94d\",\"label\":\"Java\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Loop index variable with a very generic name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"for (int index = 0; index < entryCount; ++index)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Imagine you’re iterating over characters or words. Whether or not the element at \"},{\"type\":\"text\",\"text\":\"index\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is a character or word can make a big difference.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"You can clarify exactly what is being indexed into by making the loop index variable names contain that information:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"for (int characterIndex = 0; characterIndex < characterCount; ++characterIndex)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"That would make code like \"},{\"type\":\"text\",\"text\":\"words[character_index]\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" clearly look wrong - the wrong kind of index is used to lookup a word.\"}]}]},\"fullName\":\"Java\",\"minHeight\":0},{\"id\":\"b386b107-e0e7-436c-8cf0-9f67def39c67\",\"label\":\"Python\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Loop index variable with a very generic name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"for index in range(entry_count):\\n # ...\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Imagine you’re iterating over characters or words. Whether or not the element at \"},{\"type\":\"text\",\"text\":\"index\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is a character or word can make a big difference.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"You can clarify exactly what is being indexed into by making the loop index variable names contain that information:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"for character_index in range(character_count):\\n # ...\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"That would make code like \"},{\"type\":\"text\",\"text\":\"words[character_index]\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" clearly look wrong - the wrong kind of index is used to lookup a word.\"}]}]},\"fullName\":\"Python\",\"minHeight\":0},{\"id\":\"c1dd5c0a-3f33-44b8-922e-3e86212a1cc2\",\"label\":\"JavaScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Loop index variable with a very generic name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"for (let index = 0; index < entryCount; ++index)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Imagine you’re iterating over characters or words. Whether or not the element at \"},{\"type\":\"text\",\"text\":\"index\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is a character or word can make a big difference.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"You can clarify exactly what is being indexed into by making the loop index variable names contain that information:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"for (let characterIndex = 0; characterIndex < characterCount; ++characterIndex)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"That would make code like \"},{\"type\":\"text\",\"text\":\"words[character_index]\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" clearly look wrong - the wrong kind of index is used to lookup a word.\"}]}]},\"fullName\":\"JavaScript\",\"minHeight\":0},{\"id\":\"4f898ad1-3b98-4b4b-af3e-2c2c9759a9a6\",\"label\":\"TypeScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Poor practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"Loop index variable with a very generic name:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"for (let index = 0; index < entryCount; ++index)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Imagine you’re iterating over characters or words. Whether or not the element at \"},{\"type\":\"text\",\"text\":\"index\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" is a character or word can make a big difference.\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Better practice: \",\"marks\":[{\"type\":\"strong\"}]},{\"type\":\"text\",\"text\":\"You can clarify exactly what is being indexed into by making the loop index variable names contain that information:\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"for (let characterIndex = 0; characterIndex < characterCount; ++characterIndex)\\n{\\n // ...\\n}\"}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"That would make code like \"},{\"type\":\"text\",\"text\":\"words[character_index]\",\"marks\":[{\"type\":\"code\"}]},{\"type\":\"text\",\"text\":\" clearly look wrong - the wrong kind of index is used to lookup a word.\"}]}]},\"fullName\":\"TypeScript\",\"minHeight\":0}],\"design\":null,\"designType\":\"tab\",\"vertical\":false,\"showTabCard\":true,\"width\":150,\"isEmbedded\":false,\"minHeight\":500,\"lastTabWidth\":150,\"pages\":[\"f084105e-f3ab-4640-bb92-5393cb166695\",\"9d248694-90d1-47bc-8ad5-7ae0a8890d44\",\"2d94fa26-ae2f-458c-8026-fdd41c71d94d\",\"b386b107-e0e7-436c-8cf0-9f67def39c67\",\"c1dd5c0a-3f33-44b8-922e-3e86212a1cc2\",\"4f898ad1-3b98-4b4b-af3e-2c2c9759a9a6\"]},\"labeled\":{\"labels\":[]},\"childpages\":{}}"}},"macroMetadata":{"macroId":{"value":"73249003-2947-4f9a-9dfa-332570567fe0"},"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":"2fec7483-bb70-4854-820d-6b985eeba691"}},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1820,"alt":"Deep coding during work hours ad.png","id":"29b6c77b-1962-439c-898f-1d5cdbc7c4d8","collection":"contentId-103842079","type":"file","height":376},"marks":[{"type":"link","attrs":{"href":"https://www.pulsepoint-ai.com/developers"}}]}]}],"version":1}

Name Loop Indices Based on What is Being Iterated Over [VD2]