Iconos SCW
héroe bg sin separador
Blog

使用重写操作向注释添加参数

Alan Richardson
Publicado el 26 de octubre de 2020
Última actualización el 9 de marzo de 2026

在这篇博客文章中,我们将:

  • 演示搜索和匹配注释
  • Amen 使用胡子模板进行注释

Sensei 提供了匹配有问题的代码模式,然后将其修改为商定的实现方式的能力。在此示例中,我使用不带参数的 @Disabled 作为有问题的代码模式。

禁用测试注释

从长远来看,没有指定原因的禁用测试可能会出现问题,因为我们忘记了禁用它的原因。


@Disabled
void 此测试方法没有禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

风险在于,随着时间的推移,代码库会继续发展,禁用测试的更新与代码的目的不一致,最终变得多余且无关紧要,并且可能永远不会重新启用。

在代码审查期间,我们经常会指出,添加解释性描述作为注解参数是个好主意。


@Disabled(“为演示添加原因而禁用”)
void 此测试方法已禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

老师食谱

我们可以编写一个不加解释的方法来检测何时添加 @Disabled,并编写一个快速修复来提醒我们添加解释禁用它的实际原因。

当我想到自己要做什么时,我必须:

  • 匹配不带任何参数的 Disabled 注解
  • 将 “已禁用” 注释更改为使用带有标记文本 “TODO:在此处添加描述” 的参数

创建警告食谱

我使用 Alt+Enter 来创建新的食谱。

Crear una nueva función de receta

然后在一般信息中添加基本的描述性文本。

Configuración general

通过将该规则设为警告,任何匹配的代码都会突出显示,但不会显示为明显错误。

Hacer de la norma una advertencia

查找注释

在食谱编辑器中,我更改了搜索以匹配注释。

这将突出显示预览中的所有注释。

Editor de recetas

这样做之后,我想过滤注释的类型。

我可以只使用 Disabled,但我完全符合该包的课程资格,因此它只能与 JUnit 5 中的注解相匹配。因为源代码显示在预览中,所以我可以轻松地将其从实际代码中复制并粘贴进去,以避免出现任何错别字。

然后我只想匹配没有参数的注释,我可以使用 GUI 来做到这一点。

Ajustes de la receta

即搜索:

搜索:
注解:
键入:“org.junit.jupiter.api.Disabled”
没有:
参数:
-{}

创建重写快速修复操作

对于我的 QuickFix,我将使用重写操作。

我用 显示变量 向我显示 Mustache 变量并预览内容的功能。

Ajustes de QuickFix

然后我添加了创建位置标记注释所需的额外代码。

Añadir código extra para crear el comentario del marcador de posición

即 QuickFix:

可用修复程序:
-名称:“添加待办事项评论参数”
行动:
-重写:
到:“{{{.}} (\" TODO:在此添加描述\”)”
目标:“自我”

老师在行动

我们制作了一个简短的视频,展示了食谱创建过程的实际情况。

摘要

在构建 rewrite Quick Fix 时,我们可以更轻松地搜索要重写的代码元素,因为这样我们就可以对其进行操作的自我实体。

在此示例中,我使用重写操作来修改注释。Rewrite 是一种通用操作,可以应用于任何代码元素,是很好的浏览默认操作。

Ver recursos
Ver recursos

通过注解匹配示例,学习如何使用 Sensei 来匹配有问题的代码模式,然后将其修改为商定的实现。

¿Te interesa saber más?

Alan Richardson cuenta con más de veinte años de experiencia profesional en TI, trabajando como desarrollador y en todos los niveles de la jerarquía de pruebas, desde probador hasta jefe de pruebas. Jefe de Relaciones con los Desarrolladores en Secure Code Warrior, trabaja directamente con los equipos, para mejorar el desarrollo de un código seguro de calidad. Alan es autor de cuatro libros, entre ellos "Dear Evil Tester" y "Java For Testers". Alan también ha creado una formación en línea courses para ayudar a la gente a aprender las pruebas técnicas de la web y Selenium WebDriver con Java. Alan publica sus escritos y vídeos de formación en SeleniumSimplified.com, EvilTester.com, JavaForTesters.com, y CompendiumDev.co.uk.

Más información

Secure Code Warrior puede ayudar a su organización a proteger el código a lo largo de todo el ciclo de vida del desarrollo de software y a crear una cultura que dé prioridad a la ciberseguridad. Tanto si es usted responsable de seguridad de aplicaciones, desarrollador, director de seguridad de la información o cualquier otra persona relacionada con la seguridad, podemos ayudar a su organización a reducir los riesgos asociados al código inseguro.

Reservar una demostración
Compartir en:
marcas de LinkedInSocialx logotipo
Autor
Alan Richardson
Publicado el 26 de octubre de 2020

Alan Richardson cuenta con más de veinte años de experiencia profesional en TI, trabajando como desarrollador y en todos los niveles de la jerarquía de pruebas, desde probador hasta jefe de pruebas. Jefe de Relaciones con los Desarrolladores en Secure Code Warrior, trabaja directamente con los equipos, para mejorar el desarrollo de un código seguro de calidad. Alan es autor de cuatro libros, entre ellos "Dear Evil Tester" y "Java For Testers". Alan también ha creado una formación en línea courses para ayudar a la gente a aprender las pruebas técnicas de la web y Selenium WebDriver con Java. Alan publica sus escritos y vídeos de formación en SeleniumSimplified.com, EvilTester.com, JavaForTesters.com, y CompendiumDev.co.uk.

Compartir en:
marcas de LinkedInSocialx logotipo

在这篇博客文章中,我们将:

  • 演示搜索和匹配注释
  • Amen 使用胡子模板进行注释

Sensei 提供了匹配有问题的代码模式,然后将其修改为商定的实现方式的能力。在此示例中,我使用不带参数的 @Disabled 作为有问题的代码模式。

禁用测试注释

从长远来看,没有指定原因的禁用测试可能会出现问题,因为我们忘记了禁用它的原因。


@Disabled
void 此测试方法没有禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

风险在于,随着时间的推移,代码库会继续发展,禁用测试的更新与代码的目的不一致,最终变得多余且无关紧要,并且可能永远不会重新启用。

在代码审查期间,我们经常会指出,添加解释性描述作为注解参数是个好主意。


@Disabled(“为演示添加原因而禁用”)
void 此测试方法已禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

老师食谱

我们可以编写一个不加解释的方法来检测何时添加 @Disabled,并编写一个快速修复来提醒我们添加解释禁用它的实际原因。

当我想到自己要做什么时,我必须:

  • 匹配不带任何参数的 Disabled 注解
  • 将 “已禁用” 注释更改为使用带有标记文本 “TODO:在此处添加描述” 的参数

创建警告食谱

我使用 Alt+Enter 来创建新的食谱。

Crear una nueva función de receta

然后在一般信息中添加基本的描述性文本。

Configuración general

通过将该规则设为警告,任何匹配的代码都会突出显示,但不会显示为明显错误。

Hacer de la norma una advertencia

查找注释

在食谱编辑器中,我更改了搜索以匹配注释。

这将突出显示预览中的所有注释。

Editor de recetas

这样做之后,我想过滤注释的类型。

我可以只使用 Disabled,但我完全符合该包的课程资格,因此它只能与 JUnit 5 中的注解相匹配。因为源代码显示在预览中,所以我可以轻松地将其从实际代码中复制并粘贴进去,以避免出现任何错别字。

然后我只想匹配没有参数的注释,我可以使用 GUI 来做到这一点。

Ajustes de la receta

即搜索:

搜索:
注解:
键入:“org.junit.jupiter.api.Disabled”
没有:
参数:
-{}

创建重写快速修复操作

对于我的 QuickFix,我将使用重写操作。

我用 显示变量 向我显示 Mustache 变量并预览内容的功能。

Ajustes de QuickFix

然后我添加了创建位置标记注释所需的额外代码。

Añadir código extra para crear el comentario del marcador de posición

即 QuickFix:

可用修复程序:
-名称:“添加待办事项评论参数”
行动:
-重写:
到:“{{{.}} (\" TODO:在此添加描述\”)”
目标:“自我”

老师在行动

我们制作了一个简短的视频,展示了食谱创建过程的实际情况。

摘要

在构建 rewrite Quick Fix 时,我们可以更轻松地搜索要重写的代码元素,因为这样我们就可以对其进行操作的自我实体。

在此示例中,我使用重写操作来修改注释。Rewrite 是一种通用操作,可以应用于任何代码元素,是很好的浏览默认操作。

Ver recursos
Ver recursos

Rellene el siguiente formulario para descargar el informe.

Nos gustaría obtener su permiso para enviarle información sobre nuestros productos y/o temas relacionados con la codificación de seguridad. Trataremos su información personal con el máximo cuidado y nunca la venderemos a otras empresas con fines comerciales.

Enviar
Icono de éxito de SCW
Icono de error scw
Para enviar el formulario, habilite las cookies de análisis. Una vez completado, puede desactivarlas nuevamente si lo desea.

在这篇博客文章中,我们将:

  • 演示搜索和匹配注释
  • Amen 使用胡子模板进行注释

Sensei 提供了匹配有问题的代码模式,然后将其修改为商定的实现方式的能力。在此示例中,我使用不带参数的 @Disabled 作为有问题的代码模式。

禁用测试注释

从长远来看,没有指定原因的禁用测试可能会出现问题,因为我们忘记了禁用它的原因。


@Disabled
void 此测试方法没有禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

风险在于,随着时间的推移,代码库会继续发展,禁用测试的更新与代码的目的不一致,最终变得多余且无关紧要,并且可能永远不会重新启用。

在代码审查期间,我们经常会指出,添加解释性描述作为注解参数是个好主意。


@Disabled(“为演示添加原因而禁用”)
void 此测试方法已禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

老师食谱

我们可以编写一个不加解释的方法来检测何时添加 @Disabled,并编写一个快速修复来提醒我们添加解释禁用它的实际原因。

当我想到自己要做什么时,我必须:

  • 匹配不带任何参数的 Disabled 注解
  • 将 “已禁用” 注释更改为使用带有标记文本 “TODO:在此处添加描述” 的参数

创建警告食谱

我使用 Alt+Enter 来创建新的食谱。

Crear una nueva función de receta

然后在一般信息中添加基本的描述性文本。

Configuración general

通过将该规则设为警告,任何匹配的代码都会突出显示,但不会显示为明显错误。

Hacer de la norma una advertencia

查找注释

在食谱编辑器中,我更改了搜索以匹配注释。

这将突出显示预览中的所有注释。

Editor de recetas

这样做之后,我想过滤注释的类型。

我可以只使用 Disabled,但我完全符合该包的课程资格,因此它只能与 JUnit 5 中的注解相匹配。因为源代码显示在预览中,所以我可以轻松地将其从实际代码中复制并粘贴进去,以避免出现任何错别字。

然后我只想匹配没有参数的注释,我可以使用 GUI 来做到这一点。

Ajustes de la receta

即搜索:

搜索:
注解:
键入:“org.junit.jupiter.api.Disabled”
没有:
参数:
-{}

创建重写快速修复操作

对于我的 QuickFix,我将使用重写操作。

我用 显示变量 向我显示 Mustache 变量并预览内容的功能。

Ajustes de QuickFix

然后我添加了创建位置标记注释所需的额外代码。

Añadir código extra para crear el comentario del marcador de posición

即 QuickFix:

可用修复程序:
-名称:“添加待办事项评论参数”
行动:
-重写:
到:“{{{.}} (\" TODO:在此添加描述\”)”
目标:“自我”

老师在行动

我们制作了一个简短的视频,展示了食谱创建过程的实际情况。

摘要

在构建 rewrite Quick Fix 时,我们可以更轻松地搜索要重写的代码元素,因为这样我们就可以对其进行操作的自我实体。

在此示例中,我使用重写操作来修改注释。Rewrite 是一种通用操作,可以应用于任何代码元素,是很好的浏览默认操作。

Ver el seminario web
Empecemos.
Más información

Haga clic en el siguiente enlace y descargue el PDF de este recurso.

Secure Code Warrior puede ayudar a su organización a proteger el código a lo largo de todo el ciclo de vida del desarrollo de software y a crear una cultura que dé prioridad a la ciberseguridad. Tanto si es usted responsable de seguridad de aplicaciones, desarrollador, director de seguridad de la información o cualquier otra persona relacionada con la seguridad, podemos ayudar a su organización a reducir los riesgos asociados al código inseguro.

Ver informeReservar una demostración
Ver recursos
Compartir en:
marcas de LinkedInSocialx logotipo
¿Te interesa saber más?

Compartir en:
marcas de LinkedInSocialx logotipo
Autor
Alan Richardson
Publicado el 26 de octubre de 2020

Alan Richardson cuenta con más de veinte años de experiencia profesional en TI, trabajando como desarrollador y en todos los niveles de la jerarquía de pruebas, desde probador hasta jefe de pruebas. Jefe de Relaciones con los Desarrolladores en Secure Code Warrior, trabaja directamente con los equipos, para mejorar el desarrollo de un código seguro de calidad. Alan es autor de cuatro libros, entre ellos "Dear Evil Tester" y "Java For Testers". Alan también ha creado una formación en línea courses para ayudar a la gente a aprender las pruebas técnicas de la web y Selenium WebDriver con Java. Alan publica sus escritos y vídeos de formación en SeleniumSimplified.com, EvilTester.com, JavaForTesters.com, y CompendiumDev.co.uk.

Compartir en:
marcas de LinkedInSocialx logotipo

在这篇博客文章中,我们将:

  • 演示搜索和匹配注释
  • Amen 使用胡子模板进行注释

Sensei 提供了匹配有问题的代码模式,然后将其修改为商定的实现方式的能力。在此示例中,我使用不带参数的 @Disabled 作为有问题的代码模式。

禁用测试注释

从长远来看,没有指定原因的禁用测试可能会出现问题,因为我们忘记了禁用它的原因。


@Disabled
void 此测试方法没有禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

风险在于,随着时间的推移,代码库会继续发展,禁用测试的更新与代码的目的不一致,最终变得多余且无关紧要,并且可能永远不会重新启用。

在代码审查期间,我们经常会指出,添加解释性描述作为注解参数是个好主意。


@Disabled(“为演示添加原因而禁用”)
void 此测试方法已禁用 reason () {
assertions.fail(“此测试已禁用,不应运行”);
}

老师食谱

我们可以编写一个不加解释的方法来检测何时添加 @Disabled,并编写一个快速修复来提醒我们添加解释禁用它的实际原因。

当我想到自己要做什么时,我必须:

  • 匹配不带任何参数的 Disabled 注解
  • 将 “已禁用” 注释更改为使用带有标记文本 “TODO:在此处添加描述” 的参数

创建警告食谱

我使用 Alt+Enter 来创建新的食谱。

Crear una nueva función de receta

然后在一般信息中添加基本的描述性文本。

Configuración general

通过将该规则设为警告,任何匹配的代码都会突出显示,但不会显示为明显错误。

Hacer de la norma una advertencia

查找注释

在食谱编辑器中,我更改了搜索以匹配注释。

这将突出显示预览中的所有注释。

Editor de recetas

这样做之后,我想过滤注释的类型。

我可以只使用 Disabled,但我完全符合该包的课程资格,因此它只能与 JUnit 5 中的注解相匹配。因为源代码显示在预览中,所以我可以轻松地将其从实际代码中复制并粘贴进去,以避免出现任何错别字。

然后我只想匹配没有参数的注释,我可以使用 GUI 来做到这一点。

Ajustes de la receta

即搜索:

搜索:
注解:
键入:“org.junit.jupiter.api.Disabled”
没有:
参数:
-{}

创建重写快速修复操作

对于我的 QuickFix,我将使用重写操作。

我用 显示变量 向我显示 Mustache 变量并预览内容的功能。

Ajustes de QuickFix

然后我添加了创建位置标记注释所需的额外代码。

Añadir código extra para crear el comentario del marcador de posición

即 QuickFix:

可用修复程序:
-名称:“添加待办事项评论参数”
行动:
-重写:
到:“{{{.}} (\" TODO:在此添加描述\”)”
目标:“自我”

老师在行动

我们制作了一个简短的视频,展示了食谱创建过程的实际情况。

摘要

在构建 rewrite Quick Fix 时,我们可以更轻松地搜索要重写的代码元素,因为这样我们就可以对其进行操作的自我实体。

在此示例中,我使用重写操作来修改注释。Rewrite 是一种通用操作,可以应用于任何代码元素,是很好的浏览默认操作。

Índice

Descargar PDF
Ver recursos
¿Te interesa saber más?

Alan Richardson cuenta con más de veinte años de experiencia profesional en TI, trabajando como desarrollador y en todos los niveles de la jerarquía de pruebas, desde probador hasta jefe de pruebas. Jefe de Relaciones con los Desarrolladores en Secure Code Warrior, trabaja directamente con los equipos, para mejorar el desarrollo de un código seguro de calidad. Alan es autor de cuatro libros, entre ellos "Dear Evil Tester" y "Java For Testers". Alan también ha creado una formación en línea courses para ayudar a la gente a aprender las pruebas técnicas de la web y Selenium WebDriver con Java. Alan publica sus escritos y vídeos de formación en SeleniumSimplified.com, EvilTester.com, JavaForTesters.com, y CompendiumDev.co.uk.

Más información

Secure Code Warrior puede ayudar a su organización a proteger el código a lo largo de todo el ciclo de vida del desarrollo de software y a crear una cultura que dé prioridad a la ciberseguridad. Tanto si es usted responsable de seguridad de aplicaciones, desarrollador, director de seguridad de la información o cualquier otra persona relacionada con la seguridad, podemos ayudar a su organización a reducir los riesgos asociados al código inseguro.

Reservar una demostraciónDescargar
Compartir en:
marcas de LinkedInSocialx logotipo
Centro de recursos

Recursos para ayudarle a empezar

Más publicaciones
Centro de recursos

Recursos para ayudarle a empezar

Más publicaciones