{"type":"doc","content":[{"type":"panel","attrs":{"panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Tip DS7","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Many data types - notably classes - can grow to be pretty long, particularly if they have many methods or member variables. In such cases, consider using MAJOR section heading comments or ","type":"text"},{"text":"#region","type":"text","marks":[{"type":"code"}]},{"text":"s (if your language/environment supports them) to divide a class into clear, cohesive sections to help readers find what they are looking for.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"See the following example:","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\":\"25cb4d1e-2598-4432-9563-987111efbb65\",\"label\":\"C++\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"c++\"},\"content\":[{\"type\":\"text\",\"text\":\"/// A window implemented using the Win32 API for the Windows operating system.\\nclass Win32Window\\n{\\npublic:\\n // CONSTRUCTION.\\n static std::unique_ptr Create(\\n const WNDCLASSEX& window_class,\\n const std::string& window_title,\\n const int width_in_pixels = CW_USEDEFAULT,\\n const int height_in_pixels = CW_USEDEFAULT);\\n explicit Win32Window(const HWND window_handle);\\n\\n // DIMENSIONS.\\n unsigned int GetWidthInPixels() const;\\n unsigned int GetHeightInPixels() const;\\n\\n // RENDERING.\\n void Display(const Bitmap& bitmap);\\n void DisplayAt(const Bitmap& bitmap, int left_x, int top_y);\\n\\n // MEMBER VARIABLES.\\n /// The handle to window.\\n HWND WindowHandle;\\n};\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C++\",\"minHeight\":0},{\"id\":\"2f8855fd-eeb6-4a45-aa5c-e46c1dfc1c41\",\"label\":\"C#\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"csharp\"},\"content\":[{\"type\":\"text\",\"text\":\"///

\\n/// A window implemented using the Win32 API for the Windows operating system.\\n///

\\npublic class Win32Window\\n{\\n #region Properties\\n ///

\\n /// The handle to the window.\\n ///

\\n public IntPtr WindowHandle { get; private set; }\\n #endregion\\n\\n #region Construction\\n ///

\\n /// Creates a new instance of the Win32Window class.\\n ///

\\n /// The window title.\\n /// The width of the client area within the window, in pixels.\\n /// The height of the client area within the window, in pixels.\\n /// The window if successfully created; null otherwise.\\n public static Win32Window Create(\\n string windowTitle,\\n int widthInPixels,\\n int heightInPixels)\\n {\\n // ...\\n return null;\\n }\\n\\n ///

\\n /// Initializes a new instance of the Win32Window class.\\n ///

\\n /// The operating system handle to the window wrapped by this class.\\n public Win32Window(IntPtr windowHandle)\\n {\\n WindowHandle = windowHandle;\\n }\\n #endregion\\n\\n #region Dimensions\\n ///

\\n /// Gets the width of the window's display area.\\n ///

\\n /// The width of the window's display area, in pixels.\\n public int GetWidthInPixels()\\n {\\n // ...\\n return 0;\\n }\\n\\n ///

\\n /// Gets the height of the window's display area.\\n ///

\\n /// The height of the window's display area, in pixels.\\n public int GetHeightInPixels()\\n {\\n // ...\\n return 0;\\n }\\n #endregion\\n\\n #region Rendering\\n ///

\\n /// Displays the provided bitmap in the window.\\n ///

\\n /// The bitmap to display.\\n public void Display(Bitmap bitmap)\\n {\\n // ...\\n }\\n\\n ///

\\n /// Displays a bitmap at the specified location in the window.\\n ///

\\n /// The bitmap to display.\\n /// The left x offset from the left of the window in which to display the bitmap.\\n /// The top y offset from the top of the window in which to display the bitmap.\\n public void DisplayAt(Bitmap bitmap, int leftX, int topY)\\n {\\n // ...\\n }\\n #endregion\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"C#\",\"minHeight\":0},{\"id\":\"d3accd78-e297-44e1-b0a4-2fe6859b9004\",\"label\":\"Java\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"java\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * A window implemented using the Win32 API for the Windows operating system.\\n */\\nclass Win32Window\\n{\\n // MEMBER VARIABLES.\\n /**\\n * The handle to the window.\\n */\\n public long windowHandle = 0;\\n\\n // CONSTRUCTION.\\n /**\\n * Attempts to create a new window based on the provided description.\\n * The window will be displayed if successfully created.\\n * @param windowTitle - The window title.\\n * @param widthInPixels - The width of the client area within the window, in pixels.\\n * @param heightInPixels - The height of the client area within the window, in pixels.\\n * @return The window if successfully created; null otherwise.\\n */\\n public static Win32Window create(\\n String windowTitle,\\n int widthInPixels,\\n int heightInPixels) \\n {\\n // ...\\n return null;\\n }\\n\\n /**\\n * Initializes the window with a reference to its handle.\\n * @param windowHandle - The operating system handle to the window wrapped by this class.\\n */\\n public Win32Window(long windowHandle)\\n {\\n this.windowHandle = windowHandle;\\n }\\n\\n // DIMENSIONS.\\n /**\\n * Gets the width of the window's display area.\\n * @return The width of the window's display area, in pixels.\\n */\\n public int getWidthInPixels()\\n {\\n // ...\\n return 0;\\n }\\n\\n /**\\n * Gets the height of the window's display area.\\n * @return The height of the window's display area, in pixels.\\n */\\n public int getHeightInPixels()\\n {\\n // ...\\n return 0;\\n }\\n\\n // RENDERING.\\n /**\\n * Displays the provided bitmap in the window.\\n * @param bitmap - The bitmap to display.\\n */\\n public void display(Bitmap bitmap)\\n {\\n // ...\\n }\\n\\n /**\\n * Displays a bitmap at the specified location in the window.\\n * @param bitmap - The bitmap to display.\\n * @param leftX - The left x offset from the left of the window in which to display the bitmap.\\n * @param topY - The top y offset from the top of the window in which to display the bitmap.\\n */\\n public void displayAt(Bitmap bitmap, int leftX, int topY)\\n {\\n // ...\\n }\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Java\",\"minHeight\":0},{\"id\":\"29e04221-abb9-4804-b2ae-18e4753c1c30\",\"label\":\"Python\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"type\":\"text\",\"text\":\"class Win32Window:\\n # CREATION.\\n @staticmethod\\n def create(window_title: str, width_in_pixels: int, height_in_pixels: int):\\n # ...\\n pass\\n\\n # DIMENSIONS.\\n def get_width_in_pixels(self) -> int:\\n # ...\\n pass\\n\\n def get_height_in_pixels(self) -> int:\\n # ...\\n pass\\n\\n # RENDERING.\\n def display(self, bitmap: Bitmap):\\n # ...\\n pass\\n\\n def display_at(self, bitmap: Bitmap, left_x: int, top_y: int):\\n # ...\\n pass\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"Python\",\"minHeight\":0},{\"id\":\"abd2abc3-13e8-4b34-a1a9-a6d8f8081faa\",\"label\":\"JavaScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * A window implemented using the Win32 API for the Windows operating system.\\n */\\nclass Win32Window \\n{\\n // CONSTRUCTION.\\n /**\\n * Attempts to create a new window based on the provided description.\\n * The window will be displayed if successfully created.\\n * @param {string} windowTitle - The window title.\\n * @param {number} widthInPixels - The width of the client area within the window, in pixels.\\n * @param {number} heightInPixels - The height of the client area within the window, in pixels.\\n * @returns {Win32Window} - The window if successfully created; null otherwise.\\n */\\n static create(windowTitle, widthInPixels, heightInPixels)\\n {\\n // ...\\n return null;\\n }\\n\\n /**\\n * Initializes the window with a reference to its handle.\\n * @param {number} windowHandle - The operating system handle to the window wrapped by this class.\\n */\\n constructor(windowHandle)\\n {\\n // ...\\n }\\n\\n // DIMENSIONS.\\n /**\\n * Gets the width of the window's display area.\\n * @returns {number} The width of the window's display area, in pixels.\\n */\\n getWidthInPixels()\\n {\\n // ...\\n return 0;\\n }\\n\\n /**\\n * Gets the height of the window's display area.\\n * @returns {number} The height of the window's display area, in pixels.\\n */\\n getHeightInPixels()\\n {\\n // ...\\n return 0;\\n }\\n\\n // RENDERING.\\n /**\\n * Displays the provided bitmap in the window.\\n * @param {Bitmap} bitmap - The bitmap to display.\\n */\\n display(bitmap)\\n {\\n // ...\\n }\\n\\n /**\\n * Displays a bitmap at the specified location in the window.\\n * @param {Bitmap} bitmap - The bitmap to display.\\n * @param {number} leftX - The left x offset from the left of the window in which to display the bitmap.\\n * @param {number} topY - The top y offset from the top of the window in which to display the bitmap.\\n */\\n displayAt(bitmap, leftX, topY)\\n {\\n // ...\\n }\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"JavaScript\",\"minHeight\":0},{\"id\":\"8976dd99-b0f5-4d24-b486-03eca6f79812\",\"label\":\"TypeScript\",\"type\":\"your-content\",\"body\":{\"version\":1,\"type\":\"doc\",\"content\":[{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"typescript\"},\"content\":[{\"type\":\"text\",\"text\":\"/**\\n * A window implemented using the Win32 API for the Windows operating system.\\n */\\nclass Win32Window\\n{\\n // MEMBER VARIABLES.\\n /**\\n * The handle to the window.\\n */\\n private windowHandle: number = 0;\\n\\n // CONSTRUCTION.\\n /**\\n * Attempts to create a new window based on the provided description.\\n * The window will be displayed if successfully created.\\n * @param windowTitle - The window title.\\n * @param widthInPixels - The width of the client area within the window, in pixels.\\n * @param heightInPixels - The height of the client area within the window, in pixels.\\n * @returns The window if successfully created; null otherwise.\\n */\\n static create(windowTitle: string, widthInPixels: number, heightInPixels: number): Win32Window\\n {\\n // ...\\n return null;\\n }\\n\\n /**\\n * Initializes the window with a reference to its handle.\\n * @param windowHandle - The operating system handle to the window wrapped by this class.\\n */\\n constructor(windowHandle: number)\\n {\\n this.windowHandle = windowHandle;\\n }\\n\\n // DIMENSIONS.\\n /**\\n * Gets the width of the window's display area.\\n * @returns The width of the window's display area, in pixels.\\n */\\n getWidthInPixels(): number \\n {\\n // ...\\n return 0;\\n }\\n\\n /**\\n * Gets the height of the window's display area.\\n * @returns The height of the window's display area, in pixels.\\n */\\n getHeightInPixels(): number\\n {\\n // ...\\n return 0;\\n }\\n\\n // RENDERING.\\n /**\\n * Displays the provided bitmap in the window.\\n * @param bitmap - The bitmap to display.\\n */\\n display(bitmap: Bitmap)\\n {\\n // ...\\n }\\n\\n /**\\n * Displays a bitmap at the specified location in the window.\\n * @param bitmap - The bitmap to display.\\n * @param leftX - The left x offset from the left of the window in which to display the bitmap.\\n * @param topY - The top y offset from the top of the window in which to display the bitmap.\\n */\\n displayAt(bitmap: Bitmap, leftX: number, topY: number)\\n {\\n // ...\\n }\\n}\"}]},{\"type\":\"paragraph\",\"content\":[]}]},\"fullName\":\"TypeScript\",\"minHeight\":0}],\"design\":null,\"designType\":\"tab\",\"vertical\":false,\"showTabCard\":true,\"width\":150,\"isEmbedded\":false,\"minHeight\":665,\"lastTabWidth\":150,\"pages\":[\"25cb4d1e-2598-4432-9563-987111efbb65\",\"2f8855fd-eeb6-4a45-aa5c-e46c1dfc1c41\",\"d3accd78-e297-44e1-b0a4-2fe6859b9004\",\"29e04221-abb9-4804-b2ae-18e4753c1c30\",\"abd2abc3-13e8-4b34-a1a9-a6d8f8081faa\",\"8976dd99-b0f5-4d24-b486-03eca6f79812\"]},\"labeled\":{\"labels\":[]},\"childpages\":{}}"}},"macroMetadata":{"macroId":{"value":"0e60855a-ba6e-4a02-b922-139aa15e5bca"},"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":"e33ad594-6935-47f1-ab29-d0f9c6839de5"}},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1822,"alt":"Code in the zone ad.png","id":"ceaf06f7-2013-463c-b893-1954e950dce7","collection":"contentId-102662196","type":"file","height":377},"marks":[{"type":"link","attrs":{"href":"https://www.pulsepoint-ai.com/developers"}}]}]}],"version":1}

Consider Using MAJOR Comments to Divide Longer Data Types into Clear Sections [DS7] [WHAT] [WHERE]