{"type":"doc","content":[{"type":"panel","attrs":{"panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Tip DI19","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Many languages allow functions to have default values for some parameters. In such cases, document the meaning and reason behind the default values. This helps others know if a default value exists for just a “convenience” reason or if there are more important considerations.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"See the following:","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\":\"61469c75-5e66-429f-9775-da86eecc9d3f\",\"label\":\"C++\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"/// Constructor for a color.\\n/// \\\\param[in] red - The red channel of the color, in the range [0,1].\\n/// \\\\param[in] green - The green channel of the color, in the range [0,1].\\n/// \\\\param[in] blue - The blue channel of the color, in the range [0,1].\\n/// \\\\param[in] alpha - The blue channel of the color, in the range [0,1].\\n/// Defaults to 1 to indicate fully opaque, which makes it more convenient\\n/// to create most colors.\\nexplicit Color(const float red, const float green, const float blue, const float alpha = 1.0f);\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C++\",\"minHeight\":350},{\"id\":\"b2f9d602-8141-4e9d-9036-14c3b5ad3ef8\",\"label\":\"C#\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"///

\\n/// Constructor for a color.\\n///

\\n/// The red channel of the color, in the range [0,1].\\n/// The green channel of the color, in the range [0,1].\\n/// The blue channel of the color, in the range [0,1].\\n/// The alpha channel of the color, in the range [0,1].\\n/// Defaults to 1 to indicate fully opaque, which makes it more convenient\\n/// to create most colors.\\n/// \\npublic Color(float red, float green, float blue, float alpha = 1.0f)\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C#\",\"minHeight\":350},{\"id\":\"377ed06a-f3ec-42a3-9c47-fb1c2bb44e32\",\"label\":\"Python (Doxygen)\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"## Initializes a color.\\n## \\\\param[in] red - The red channel of the color, in the range [0, 1].\\n## \\\\param[in] green - The green channel of the color, in the range [0, 1].\\n## \\\\param[in] blue - The blue channel of the color, in the range [0, 1].\\n## \\\\param[in] alpha - The alpha channel of the color, in the range [0, 1].\\n## Defaults to 1 to indicate fully opaque, which makes it more convenient\\n## to create most colors.\\ndef __init__(self, red: float, green: float, blue: float, alpha: float = 1.0):\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Python (Doxygen)\",\"minHeight\":350},{\"id\":\"8a81bea0-591c-428a-bda6-e13e235cf32e\",\"label\":\"Python (Sphinx reST)\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"def __init__(self, red: float, green: float, blue: float, alpha: float = 1.0):\\n \\\"\\\"\\\"\\n Initializes a color.\\n\\n :param red: The red channel of the color, in the range [0, 1].\\n :param green: The green channel of the color, in the range [0, 1].\\n :param blue: The blue channel of the color, in the range [0, 1].\\n :param alpha: (optional) The alpha channel of the color, in the range [0, 1].\\n Defaults to 1 to indicate fully opaque, which makes it more convenient\\n to create most colors.\\n \\\"\\\"\\\"\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Python (Sphinx reST)\",\"minHeight\":350},{\"id\":\"9423399f-0e9e-4c90-b399-277ff859ee05\",\"label\":\"Python (Google)\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"def __init__(self, red: float, green: float, blue: float, alpha: float = 1.0):\\n \\\"\\\"\\\"\\n Initializes a color.\\n\\n Args:\\n red The red channel of the color, in the range [0,1].\\n green: The green channel of the color, in the range [0,1].\\n blue: The blue channel of the color, in the range [0,1].\\n alpha (optional): The alpha channel of the color, in the range [0,1].\\n Defaults to 1 to indicate fully opaque, which makes it more convenient\\n to create most colors.\\n \\\"\\\"\\\"\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Python (Google)\",\"minHeight\":350},{\"id\":\"6ed83a19-2420-4861-9029-17d241d9f0c5\",\"label\":\"JavaScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * Constructor for a color.\\n * @param {number} red - The red channel of the color, in the range [0,1].\\n * @param {number} green - The green channel of the color, in the range [0,1].\\n * @param {number} blue - The blue channel of the color, in the range [0,1].\\n * @param {number} [alpha=1.0] - The alpha channel of the color, in the range [0,1].\\n * Defaults to 1 to indicate fully opaque, which makes it more convenient\\n * to create most colors.\\n */\\nconstructor(red, green, blue, alpha = 1.0)\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"JavaScript\",\"minHeight\":350},{\"id\":\"f09baeba-a8a4-4c1b-95b5-ba02247f47d6\",\"label\":\"TypeScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * Constructor for a color.\\n * @param red - The red channel of the color, in the range [0,1].\\n * @param green - The green channel of the color, in the range [0,1].\\n * @param blue - The blue channel of the color, in the range [0,1].\\n * @param alpha - The alpha channel of the color, in the range [0,1].\\n * Defaults to 1 to indicate fully opaque, which makes it more convenient\\n * to create most colors.\\n */\\nconstructor(red: number, green: number, blue: number, alpha: number = 1.0)\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"TypeScript\",\"minHeight\":350}],\"design\":null,\"designType\":\"tab\",\"vertical\":false,\"showTabCard\":true,\"width\":150,\"isEmbedded\":false,\"minHeight\":300,\"lastTabWidth\":150,\"pages\":[\"61469c75-5e66-429f-9775-da86eecc9d3f\",\"b2f9d602-8141-4e9d-9036-14c3b5ad3ef8\",\"377ed06a-f3ec-42a3-9c47-fb1c2bb44e32\",\"8a81bea0-591c-428a-bda6-e13e235cf32e\",\"9423399f-0e9e-4c90-b399-277ff859ee05\",\"6ed83a19-2420-4861-9029-17d241d9f0c5\",\"f09baeba-a8a4-4c1b-95b5-ba02247f47d6\"]},\"labeled\":{\"labels\":[]},\"childpages\":{}}"}},"macroMetadata":{"macroId":{"value":"0c826e25-e5a2-4122-9996-ffb2b9904bf1"},"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":"33a9ae45-583f-4f52-8061-7586533c9b8e"}},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1822,"alt":"Code in the zone ad.png","id":"cc00c8dd-ee4c-4db3-9e53-05f8cf6c04f5","collection":"contentId-104661273","type":"file","height":377},"marks":[{"type":"link","attrs":{"href":"https://www.pulsepoint-ai.com/developers"}}]}]}],"version":1}

Document Reasons Behind Default Parameter Values [DI19] [WHY]