{"type":"doc","content":[{"type":"panel","attrs":{"panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Tip DI8","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"While certainly not required in all cases, it can sometimes be helpful to document why a data type exists. This kind of documentation can help bridge the gap between user-facing documentation and maintenance documentation, so consider it as an alternative to those kinds of documentation at times.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The following examples expand upon previous documentation to justify why a data type exists:","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\":\"771c6561-28dc-4f16-be02-ca6154296136\",\"label\":\"C++\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"/// A 2D array.\\n/// This class exists to simplify interaction with 2D arrays.\\n/// While 2D arrays are possible \\\"natively\\\" in C++, they are often more difficult\\n/// to use than necessary, requiring more manual memory management or ugly syntax.\\n/// 1D arrays can be used in a 2D manner but require more work to access elements\\n/// in an intuitive 2D manner.\\ntemplate \\nclass Array2D\\n\\n/// A random number generator. This class serves to provide\\n/// a more convenient interface (compared to the built-in C++\\n/// libraries) for certain situations of generating random numbers.\\nclass RandomNumberGenerator\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C++\",\"minHeight\":0},{\"id\":\"83d55982-a595-4bdf-b450-944dbf3487a9\",\"label\":\"C#\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"///

A 2D array.

\\n/// \\n/// This class exists to simplify interaction with 2D arrays.\\n/// While 2D arrays are possible \\\"natively\\\" in C#, they can be more difficult to use\\n/// and don't necessarily easily support all features we need for 2D arrays.\\n/// This class aims to overcome these limitations.\\n/// \\npublic class Array2D\\n\\n///

\\n/// A random number generator.\\n/// \\n/// This class serves to provide a more convenient interface\\n/// (compared to the built-in C# libraries)\\n/// for certain situations of generating random numbers.\\n///

\\npublic class RandomNumberGenerator\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C#\",\"minHeight\":0},{\"id\":\"1841a429-af13-4377-844f-35eb0d5c28c2\",\"label\":\"Java\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * A 2D array.\\n * This class exists to simplify interaction with 2D arrays.\\n * While 2D arrays are possible \\\"natively\\\" in Java, they can be more difficult to use\\n * and don't necessarily easily support all features we need for 2D arrays.\\n * This class aims to overcome these limitations.\\n */\\npublic class Array2D\\n\\n/**\\n * A random number generator. This class serves to provide\\n * a more convenient interface (compared to the built-in Java\\n * libraries) for certain situations of generating random numbers.\\n */\\npublic class RandomNumberGenerator\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Java\",\"minHeight\":0},{\"id\":\"d9ce772c-0473-40a4-89de-f4e5a541ef31\",\"label\":\"Python (Doxygen)\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"## A 2D array.\\n## This class exists to simplify interaction with 2D arrays.\\n## While 2D arrays are possible \\\"natively\\\" in Python, they can be more difficult to use\\n## and don't necessarily easily support all features we need for 2D arrays.\\n## This class aims to overcome these limitations.\\nclass Array2D(Generic[ElementType]):\\n\\n## A random number generator.\\n## This class serves to provide a more convenient interface\\n## (compared to the built-in Python libraries) for certain situations\\n## of generating random numbers.\\nclass RandomNumberGenerator:\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Python (Doxygen)\",\"minHeight\":0},{\"id\":\"ba838c27-7ad3-46d0-9aef-a8069547cef2\",\"label\":\"JavaScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * A 2D array.\\n * It is the responsibility of code using this class to handle whatever\\n * types are stored in the array.\\n * \\n * This class exists to simplify interaction with 2D arrays.\\n * While 2D arrays are possible \\\"natively\\\" in JavaScript, they can be more difficult to use\\n * and don't necessarily easily support all features we need for 2D arrays.\\n * This class aims to overcome these limitations.\\n */\\nclass Array2D\\n\\n/**\\n * A random number generator. This class serves to provide\\n * a more convenient interface (compared to the built-in JavaScript\\n * libraries) for certain situations of generating random numbers.\\n */\\nclass RandomNumberGenerator\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"JavaScript\",\"minHeight\":0},{\"id\":\"afd23665-c23b-433e-8664-79a02ec3c4c9\",\"label\":\"TypeScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * A 2D array.\\n * This class exists to simplify interaction with 2D arrays.\\n * While 2D arrays are possible \\\"natively\\\" in TypeScript, they can be more difficult to use\\n * and don't necessarily easily support all features we need for 2D arrays.\\n * This class aims to overcome these limitations.\\n */\\nclass Array2D\\n\\n/**\\n * A random number generator. This class serves to provide\\n * a more convenient interface (compared to the built-in TypeScript\\n * libraries) for certain situations of generating random numbers.\\n */\\nclass RandomNumberGenerator\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"TypeScript\",\"minHeight\":0}],\"design\":null,\"designType\":\"tab\",\"vertical\":false,\"showTabCard\":true,\"width\":150,\"isEmbedded\":false,\"minHeight\":400,\"lastTabWidth\":150,\"pages\":[\"771c6561-28dc-4f16-be02-ca6154296136\",\"83d55982-a595-4bdf-b450-944dbf3487a9\",\"1841a429-af13-4377-844f-35eb0d5c28c2\",\"d9ce772c-0473-40a4-89de-f4e5a541ef31\",\"ba838c27-7ad3-46d0-9aef-a8069547cef2\",\"afd23665-c23b-433e-8664-79a02ec3c4c9\"]},\"labeled\":{\"labels\":[]},\"childpages\":{}}"}},"macroMetadata":{"macroId":{"value":"66d0c8a0-0ff0-4134-8c8a-b64bf5ae88c3"},"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":"9d843b1a-2840-45da-a5aa-d9037405c1a8"}},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":2051,"alt":"Code More Meet Less Ad.png","id":"f7b1c8ed-3550-4fa8-ab06-cb444b01471c","collection":"contentId-102498645","type":"file","height":569},"marks":[{"type":"link","attrs":{"href":"https://www.pulsepoint-ai.com/developers"}}]}]}],"version":1}

Document Why the Data Type Exists [DI8] [WHY]