---
title: "Javadoc Method"
author: "samjavaeye"
date: "2013-05-08T17:05:24Z"
tags: []
categories: ["编程语言"]
slug: "javadoc-method"
draft: false
lastmod: "2013-05-08T17:05:24Z"
id: 1864367
url: "https://samjavaeye.iteye.com/blog/1864367"
---

**【原因分析】**

java文件中，类方法的注释不完整。例如没有写注释，或者只写了方法注释没有写参数的注释。

 

**【影响分析】**

代码可读性差，代码维护成本高。

 

**【修改建议】**

需要修改。将java类中所有方法（public和private的都要）添加上完整的注释。注释中可以使用html代码。