AddFormattedComments
Prompt
You are given a code file that contains multiple methods. Your task is to add detailed comments above all methods in this file using the comment styles and formatting consistent with the references provided by TraceAnalyticsPolicyInspector, TraceAnalyticsPolicyQualifier, and TraceMetricPolicyInspector. - For each method, write a clear descriptive comment explaining its purpose, inputs, outputs, side effects, and any important implementation details. - Use paragraph tags <p> or similar HTML-style formatting as observed in the reference comments to provide structured, readable comments. - Analyze the references to understand the tone, style, and formatting conventions for comments, then apply the same style consistently to all methods in the given file. - Ensure comments are complete but concise, aiding readability and maintainability without unnecessary verbosity. # Steps 1. Review the commenting style in TraceAnalyticsPolicyInspector, TraceAnalyticsPolicyQualifier, and TraceMetricPolicyInspector. 2. Understand the parameter descriptions, return explanations, and general comment structure used. 3. For each method in the given file: - Identify the method's purpose and behavior. - Compose a descriptive comment using <p> tags and formatting similar to the references. 4. Insert these comments immediately above each method definition. # Output Format Return the full content of the original file with the newly added formatted comments above each method. Preserve original code indentation and formatting, only adding comments. # Notes - Do not alter method code or signatures. - Follow the references exactly in terms of comment style and formatting. - If a method's purpose is unclear from the code, infer it cautiously or note TODO in the comment accordingly.
Related Coding Prompts
Write Code
As a seasoned programmer, your task is to write code in [programming language] to [perform action]. The code should be efficient, well-structured, and optimized for performance. Make sure to follow best practices and industry standards while implementing the necessary algorithms and logic to achieve the desired functionality. Test the code thoroughly to ensure it functions as intended and meets all requirements. Additionally, document the code properly for future reference and maintenance.
Debug Code
Act as a seasoned programmer with over 20 years of commercial experience. Analyze the provided [piece of code] that is causing a specific [error]. Your task involves diagnosing the root cause of the error, understanding the context and functionality intended by the code, and proposing a solution to fix the issue. Your analysis should include a step-by-step walkthrough of the code, identification of any bugs or logical mistakes, and a detailed explanation of how to resolve them. Additionally, suggest any improvements or optimizations to enhance the performance, readability, or maintainability of the code based on your extensive experience. Ensure that your solution adheres to best practices in software development and is compatible with the current development environment where the code is being executed.
Do Code Review
As a seasoned programmer with over 20 years of commercial experience, your task is to perform a comprehensive code review on the provided [piece of code]. Your review should meticulously evaluate the code's efficiency, readability, and maintainability. You are expected to identify any potential bugs, security vulnerabilities, or performance issues and suggest specific improvements or optimizations. Additionally, assess the code's adherence to industry standards and best practices. Your feedback should be constructive and detailed, offering clear explanations and recommendations for changes. Where applicable, provide examples or references to support your suggestions. Your goal is to ensure that the code not only functions as intended but also meets high standards of quality and can be easily managed and scaled in the future. This review is an opportunity to mentor and guide less experienced developers, so your insights should be both educational and actionable.