避免 AutoDoc 生成 @param & @return
Avoid AutoDoc Generation Of @param & @return
在静态类型语言中,@return 和@param 通常是冗余的,无法包含在文档中。事实上 Android 并没有将它们包含在它们自己的约定中:
不幸的是,默认情况下,如果您使用 /**
创建文档注释,您将获得样板 @param 和 @return
/**
* Some function with some purpose
* @param variableName
* @return
*/
当我在 Android Studio 中创建文档注释时,我可以关闭自动生成 @param 和 @return 吗?
到目前为止,我找到的最佳解决方案是使用 /*
而不是 /**
来开始评论
在静态类型语言中,@return 和@param 通常是冗余的,无法包含在文档中。事实上 Android 并没有将它们包含在它们自己的约定中:
不幸的是,默认情况下,如果您使用 /**
创建文档注释,您将获得样板 @param 和 @return
/**
* Some function with some purpose
* @param variableName
* @return
*/
当我在 Android Studio 中创建文档注释时,我可以关闭自动生成 @param 和 @return 吗?
到目前为止,我找到的最佳解决方案是使用 /*
而不是 /**