代码形象-命名规范和Javadoc

最近写项目的业务逻辑层的时候，对方法的命名每次都不同，所以每次在Controller层用起来很别扭，于是找了找相关的资料做了一下总结

命名规范

方法命名规范

方法命名时，一般首字母小写，采用驼峰命名法。通常采用动词+名词的组合

表述获取

表示获取一个值时，采用get作为前缀

public String getArticleTitle(){};

表述查询

查询一条或多条数据时，采用find/query作为前缀

public Article findArticle() {};

public List<Article> findArticleList() {};

public List<Article> queryAllArticle() {};

表述条件

需要条件参数时，通过by/with进行连接

public Article findArticleById(Integer articleId) {};

public String getNameByProperty(String Property) {};

表述设置

如果一个方法要设置、插入、删除、修改等操作，应该将对应动词(设置set、插入save/insert、删除delete/remove、修改update)作为前缀

public void setUserName(String name) {};

public Article save(Article article) {};

public void removeArticle(Article article) {};

public void update(Article article) {};

表述其他

如果方法返回Boolean类型时，一般使用is/has作为前缀

用于转换数据类型时，中间用to连接

public boolean isTop() {};

public Map<String, Object> ArticleToMap() {};

阿里命名建议

Javadoc

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@开头，以}结束。Javadoc 可以识别的标签如下表所示：

标签	描述	示例
@author	标识一个类的作者，一般用于类注释	@author description
@deprecated	指名一个过期的类或成员，表明该类或方法不建议使用	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	可能抛出异常的说明，一般用于方法注释	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate superclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数，一般用于方法注释	@param parameter-name explanation
@return	说明返回值类型，一般用于方法注释，不能出现再构造方法中	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过 writeObject() 和 writeExternal() 方法写的数据	@serialData description
@serialField	说明一个 ObjectStreamField 组件	@serialField name type description
@since	说明从哪个版本起开始有了这个函数	@since release
@throws	和 @exception 标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是 static 属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本，一般用于类注释	@version info

类和接口

/**
 * 这个类或者方法的描述
 * @Author Constantine
 * @Date 2022/02/27
 */

方法

/**
 * 接口里的方法 <br>
 * 通过 文章ID 查找文章
 * @Author Constantine
 * @param articleId 文章ID
 * @return 相关文章
 */
Article findArticleById(Integer articleId);

/**
 * 类里面的方法 <br>
 * {@inheritDoc}
 * @author Constantine
 */
@Override
public Article findArticleById(Integer articleId) {}

目前主要用的就是这几个，以后有需要再补充