Document method comment style - #12338
Conversation
There was a problem hiding this comment.
More details
The new rule applies only to agent instructions. It does not change runtime code.
🤖 Datadog Autotest · Commit cbc899f · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest
🟢 Java Benchmark SLOs — All performance SLOs passed
PR vs. master results
Commit: Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion. |
|
🎯 Code Coverage (details) 🔗 Commit SHA: 785c0d8 | Docs | View more details | Give us feedback! |
684a95d to
785c0d8
Compare
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
Build pipeline has failing jobs for 2c67cb3: What to do next?
DetailsSince those jobs are not marked as being allowed to fail, the pipeline will most likely fail. |
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
|
What Does This Do
Adds an agent code convention requiring concise Javadoc comments for class, method, and field documentation. The rule uses positive, active wording.
Motivation
Keeps declaration-level documentation discoverable through Java tooling and gives coding agents direct guidance without relying on negative phrasing.
Additional Notes
This is an instruction-only change with no runtime impact. The latest update addresses review feedback by replacing the previous
neverwording with an active instruction.Validation:
git diff --checkContributor Checklist
type:and (comp:orinst:) labels in addition to any other useful labelsclose,fix, or any linking keywords when referencing an issueJira ticket: N/A