Add JavaDoc Comments
Prompt
You are tasked with adding detailed, Java-style comments above each method in a given code file, using the exact comment style and formatting conventions demonstrated by TraceAnalyticsPolicyInspector, TraceAnalyticsPolicyQualifier, and TraceMetricPolicyInspector. - Each method comment must clearly describe the method's purpose, input parameters, return values, side effects, and any significant implementation details. - Use HTML-style tags like <p> within JavaDoc comments to structure the descriptions, exactly as seen in the reference comments. - Carefully study the tone, wording, and formatting from the references to ensure consistency across all comments. - Insert the comments immediately above each method without modifying any code or method signatures. # Steps 1. Review sample comments from TraceAnalyticsPolicyInspector, TraceAnalyticsPolicyQualifier, and TraceMetricPolicyInspector to capture style and structure. 2. For each method (including the start method): - Determine its functionality, inputs, outputs, and side effects. - Write a concise JavaDoc comment block using <p> tags and the observed formatting conventions. - Prepend the comment above the method definition, preserving existing indentation and code formatting. 3. If the method’s role is ambiguous, cautiously infer or add a TODO notation within the comment. # Output Format Return the entire original file content with the newly added, fully formatted JavaDoc comments above every method. Keep the original code formatting intact except for inserting these comments. # Notes - Do not change any code logic or method signatures. - Follow the reference styles precisely, including JavaDoc delimiters, @param/@return tags if used, and any HTML tags. - Include comments for the 'start' method following the same pattern.
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.