首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

让Emacs填充段落与javadoc类似的注释很好玩

让Emacs填充段落与javadoc类似的注释很好玩,可以使用Emacs的自动填充功能,并且可以使用YASnippet插件来自定义代码模板,以便快速填充注释。

Emacs是一个功能强大的文本编辑器,可以通过自动填充功能来快速填充代码,并且可以使用YASnippet插件来自定义代码模板,以便快速填充注释。

例如,可以使用以下代码模板来快速填充javadoc注释:

代码语言:txt
复制
/**
 * @author ${USER}
 * @date ${DATE}
 * @description ${1:description}
 * @param ${2:param} ${3:param description}
 * @return ${4:return value}
 */

在使用该模板时,只需要输入“javadoc”并按下TAB键,就可以自动填充注释,并且可以使用占位符来快速填充参数和描述。

除了javadoc注释外,还可以使用YASnippet插件来自定义其他类型的注释模板,例如段落注释、HTML注释等。

总之,Emacs可以通过自动填充功能和YASnippet插件来快速填充注释,这可以提高编程效率,并且可以帮助程序员更好地组织代码和文档。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

编程语言的 IDE 支持

Emacs Mode: ModeTutorial 每一各自有各自的优缺点和编写难度。但是,总的来说,没有一个方式是简单的。...- include: scope:text.html.javadoc - include: comments-inline 看了看,是不是会怀疑他们建立了语法同盟。...编程语言语法解析 Emacs 的 mode 里包含了对于语法高亮的处理,于是为了这个高亮,我们需要写写 emacs lisp 代码。...自动填充 主要可以分为两,一是:代码段(Snippets),一是:自动填充(Completion) 好像也没啥说的,就是绑定在特定关键字上的内容。...即某一型的文件,使用特定的图标来展示。 commet 。即按下注释的快捷键,能快速的注释和反注释代码。 line marker。IDEA 提供的功能,用于在行上通过图标来展示特定的功能。

2.3K31

实用主义编程规范:JAVA篇

如果只满足电脑的阅读性,源代码将很快连作者都看不懂 写代码除了关注如何实现功能,动手之前还要考虑一下命名和段落顺序、注释等要数,要为将来一年后重新阅读这些代码的人做好准备,很可能这个人就是你自己,或者是你的老板...ii.禁止出现2个以上近义词 类似Manager和Driver或者Controller都是类似的含义,但如果在代码中表达不同的概念,容易混淆;如果表达相同的概率,人厌烦,最好只用其中之一 当你难以给一个东西决定名字.../接口实现的注释,用/*……*/编写,该注释应包含针对整个或接口,是怎样实现的大概说明,而这些信息不适合作为文档的一部分。 iv....是用一个制表符(TAB键)而不是空格产生一个缩进 5.注释 a)文档注释 是用标准JAVADOC语法产生文档注释。每个公共、公共方法、公共变量必须要有中文的文档注释。 b)实现注释 i....对整个工作区目录使用SVN,作为源代码部分的版本管理,但剔除bin目录 11.代码外三要素: a)文档编写 严格按照注释要求编写javadoc类型文档注释。并且每次发布版本都自动更新文档。

1.2K60

Java 编程风格军规,看这一篇就够了

4.6.2 水平空白 除了语言需求和其它规则,并且除了文字,注释Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方: 分隔任何保留字紧随其后的左括号( ()(如 if,forcatch...*/注释,后续行必须从 *开始, 并且前一行的 *对齐。以下示例注释都是OK的。...Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释段落风格一样),那么使用 /* ... */。...7.1.2 段落 空行(即,只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。除了第一个段落,每个段落第一个单词前都有标签 ,并且它和第一个单词间没有空格。...如果一个注释是用来定义一个,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好。

93140

Google Java 编程风格指南

4.6.2 水平空白 除了语言需求和其它规则,并且除了文字,注释Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方: 分隔任何保留字紧随其后的左括号( ()(如 if,forcatch...*/注释,后续行必须从 *开始, 并且前一行的 *对齐。以下示例注释都是OK的。...Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释段落风格一样),那么使用 /* ... */。...7.1.2 段落 空行(即,只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。...如果一个注释是用来定义一个,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好。 ---- ----

1K11

Google 出品的 Java 编码规范,强烈推荐,权威又科学!

4.6.2 水平空白 除了语言需求和其它规则,并且除了文字,注释Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方: 1、分隔任何保留字紧随其后的左括号( ()(如 if,forcatch...*/注释,后续行必须从 *开始, 并且前一行的 *对齐。以下示例注释都是OK的。...Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释段落风格一样),那么使用 /* ... */。...7.1.2 段落 空行(即,只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。...如果一个注释是用来定义一个,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好。

2.6K40

Java编程风格

3.6.2 水平空白 除了语言需求和其它规则,并且除了文字、注释Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方: 分隔任何保留字紧随其后的左括号( ( )( 如if, for catch...对于多行的 /*…*/ 注释,后续行必须以星号( * )开始, 并且前一行的星号( * )对齐。以下示例注释都是OK的。.../* * 这样是 * 可以的 */ // 这样也 // 可以 /* 你也可以 * 这样 */ Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释段落风格一样),那么使用/…\/...6.1.2 段落 空行(只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。 除了第一个段落,每个段落第一个单词前都有标签\,并且它和第一个单词间没有空格。...如果一个注释是用来定义一个,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好。

2K20

Google Java编程风格规范(2020年4月原版翻译)

4.6.2 水平空白 除了语言需求和其它规则,并且除了文字,注释Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方: 分隔任何保留字紧随其后的左括号(()(如if, for catch...*/注释,后续行必须从*开始, 并且前一行的*对齐。以下示例注释都是OK的。...Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释段落风格一样),那么使用/* ... */。...7.1.2 段落 空行(即,只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。...每当一个实现注释被用来定义一个或成员的总体目标或行为时,该注释就被编写为 Javadoc (使用 / * *)。

1.1K20

抱怨Swagger不好用?好吧我换一个好用的

文档注释 YApi的文档解析基于Java注释规范,没有代码侵入!但是这就要求我们要按照Javadoc的规范进行书写文档注释,这是使用YApi的前提。一个接口文档分为以下几个部分。...接口注释 接口注释,下面是基本的格式。第一行会作为菜单展示,尽量短小精悍;第二行是接口的描述,用来描述接口的作用和细节。...接口对应的文档 ❝还有@module、@copyright什么的其实可以不写。 参数注释 入参和出参的注释,配合JSR-303有奇效哦。...呼出快捷菜单 选择Export Yapi ,首次选择会你输入YApi的服务器地址,还会你输入对应项目的token字符串。 ?...YApi提供了比Swagger更丰富的功能,具体我还在探索中,如果有什么好玩的,会在后面分享给大家,还请多多关注。

1.8K40

最全面的 Android 编码规范指南

4.8.6 注释 4.8.6.1 块注释风格 块注释与其周围的代码在同一缩进级别。它们可以是/ … /风格,也可以是// …风格。对于多行的/ … /注释,后续行必须从开始, 并且前一行的对齐。.... */ */ 注释不要封闭在由星号或其它字符绘制的框架里。 Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释段落风格一样),那么使用/ … /。...7.1.2 段落 空行(即,只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。...除了第一个段落,每个段落第一个单词前都有标签,并且它和第一个单词间没有空格。...如果一个注释是用来定义一个,方法,字段的整体目的或行为,那么这个注释应该写成Javadoc,这样更统一更友好。

1.5K40

用了VS Code、IDEA等十几款编辑器后,我总结出优秀编辑器的特质

tpope/vim 注释 轻松注释 / 取消注释行,而无需自己插入注释符号。 liuchengxu/vim-which-key 就像 emacs 的 which-key,但适用于 neovim。...真的整洁。 查找符号、查找实现的函数、继承的、超……速度都快如闪电,并且都可以很好地呈现给你,我喜欢。 语法高亮很不错。我特别喜欢 var 声明以及将参数传递给函数时的内联类型说明。...emacs/DOOM emacs 的缺点 浏览大量代码时会出现卡顿,有时人感到很不爽,特别是当你习惯用 vim/neovim 的话。...emacs 的默认设置确实非常糟糕。而且为了整个过程像 DOOM emacs 一样舒心,你需要花费大量时间阅读文档并调整配置。...容易调试键绑定问题,我希望有更多的编辑器有同样的体验。其他编辑器也有类似的功能,但不如键绑定的 echo 模式那么好用。 它的主题非常酷,整体的打字体验 / 自动完成过程非常可靠且一致。

1.8K10

Google Java编程风格指南

4.6.2 水平空白 除了语法、其他规则、词语分隔、注释javadoc外,水平的ASCII空格只在以下情况出现: 所有保留的关键字紧接它之后的位于同一行的左大括号之间需要用空格隔开。...当整个Javadoc块能容纳于一行时(且没有标记@XXX),就可以使用单行形式。 7.1.2 段落 空行(只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。...除了第一个段落,每个段落第一个单词前都有标签,并且它和第一个单词间没有空格。...7.3.2 例外:重载 如果一个方法重载了超中的方法,那么Javadoc并非必需的。 7.3.3 可选的Javadoc 对于包外不可见的和方法,如有需要,也是要使用Javadoc的。...如果一个注释是用来定义一个,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好。 原文地址: Google Java Style Guide

96920

java文档注释报错,java文档注释主要使用方法「建议收藏」

一、java包含哪些注释 1.//用于单行注释。 2./*…*/用于多行注释,从/*开始,到*/结束,不能嵌套。 3./**…*/则是为支持jdk工具javadoc.exe而特有的注释语句。...这个也就是我们所知的文档注释 在命名控制台:使用命令行在目标文件所在目录输入javadoc +文件名.java。...* {@inheritDoc} 方法、 可以集成上一个文档的注释 * {@link} 、方法 链接标签 * {@linkplain} 、方法 链接标签、上一个标签唯一的不同就是因为字体不同,如果...:Java语言的源文件 … 如何为我们的程序编写开发文档——Java文档注释 Java文档注释是用于生成Java API文档的注释,通过在程序中的.属性.方法部分加上注释,就可以用javadoc命令生成漂亮的...Javac编译器,主要做了如下的事情:1.解析填充符号表: 2.注解处理器: 3.语义分析字节码生成: 3.1.标注检查 3.2.数据及控制流分析

79320

阿里Java编程规约【三】代码格式

【强制】注释的双斜线注释内容之间有且仅有一个空格。...除此之外,也可以包含 标签,把说明分成多个段落;还可以使用 和 等相关标签,显示无序列表等结构。...一般情况下,javac 会忽略所有注释,但 @deprecated 标签是个例外。如果文档注释中有这个标签,编译器会在生成的文件中注明弃用信息,提醒其他,这个功能已经弃用。...{@inheritDoc} 如果一个方法覆盖了超的方法,或者实现了接口中的方法,那么这个方法的文档注释可以省略一些内容, javadoc 自动从被覆盖或被实现的方法中继承。...包的文档注释 javadoc 会在包所在的目录(存放包中各个的源码)中需找一个名为 package.html 的文件,这个文件中的内容就是包的文档。

87810

【作业3.0】HansBug的第三次博客规格总结

点开代码之后,发现很多地方都有注释(甚至注释行数和代码行数比例已经接近1:1),说明相关位置的功能与需求。...而违反javadoc基本格式规范的行为,显然这一设计初衷不符。建议课程组看到之后对相关部分进行全面的修改。...那么自动化难道就是帮人近似的抄一遍程序?抱歉,这样的自动化毫无意义,工程师们不可能买账的。与其这样还不如直接写单元测试,然后用脚本将单元测试程序拷贝到对应的方法注释上。...说在前面,如果读者您看不懂这段话在说啥的话,那说明不是写给您的,您可以直接跳至下一个段落,感激不尽 。 我相信您老人家这次一定又在看我的博客。嘛。。。本菜的博客有您这样的粉丝,实属蓬荜生辉。...把这样的东西的评价权力直接交给自顾不暇的初学者,或者说得更直接点,不懂工程的人强行评判工程的好坏,这样的做法显然荒唐。

27310

Java学习之变量和注释

图 2 多行注释 文档注释 包含在“/*”和“/”之间,也能注释多行内容,一般用在、方法和变量上面,用来描述其作用。注释后,鼠标放在和变量上面会自动显示出我们注释的内容,如图 3 所示。...图 3 文档注释 文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档,并输出到 HTML 文件中,方便记录程序信息。还可以包含一个或多个 @ 标签,每个 @ 标签都在新的一行开始。...关于 Javadoc 的具体标签和使用可阅读学习《Javadoc入门教程》一节。...下面看一个好玩注释: image.png 变量 Java语言是强类型(Strongly Typed)语言, 强类型包含以下两方面的含义: 所有的变量必须先声明、后使用。...指定类型的变量只能接受类型之匹配的值。 这意味着每个变量和每个表达式都有一个在编译时就确定的类型。

54510

细读 Thinking in Java (一)一切都是对象

new关键字的意思是“给我一个新对象”,上面的例子同样可以这样写: String s = new String("asdf"); 尽管这些显而易见,我们清楚String提供了这样的一个构造方法,但作者必然是按照循序渐进的思路去介绍知识点...javadoc输出的是一个HTML文件,该工具使得我们只需创建和维护单一的源文件,就能自动生成有用的文档了。 语法 所有的javadoc命令都只能在/**注释中出现,和通常一样,注释结束于*/。...而行内文档标签则可以出现在javadoc注释中的任何地方,它们也是以@字符开头,但要括在花括号内。...所有类型的注释文档都支持嵌入式HTML(、域和方法)。 一些标签示例 这里将介绍一些可用于代码文档的javadoc标签。 1.@see: 引用其它 @see标签允许用户引用其它的文档。...全部作者信息会合并到同一段落,置于生成的HTML中。

38660

10 个你进入 Emacs 世界的技巧

image.png Emacs 的修饰键变得更有意义 在 PC 键盘上,Ctrl 键被称为 C,Alt 键被称为 M,这些键并不是 C 和 M 键,由于它们总是相应的字母或符号键配对,所以在文档中容易识别...你一个应用程序的交互会影响你的工作方式,所以如果 Emacs 中所需要的按键模式特定任务不一致,那么就不要强迫自己使用 Emacs 来完成该任务。...Emacs 只是众多可供你使用的开源工具之一,没有理由自己只限于一种工具。...俄罗斯方块 Emacs 有游戏,信不信由你。有数独、拼图、扫雷、一个好玩的心理治疗师,甚至还有俄罗斯方块。...如果你想 Emacs 在你的计算生活中扮演重要角色,最终的关键是拥抱未知,开始使用 Emacs。磕磕绊绊地,直到你发现如何它为你工作,然后安下心来,享受 40 年的舒适生活。

79420

Java注释:您想知道的一切

定义注释类型后,您可以使用该类型的注释,并在其中填充值,如下所示: @ClassPreamble ( author = "Roxana Chatu", date = "2018/06/23"...不推荐使用元素时,还应使用Javadoc @deprecated标记对其进行记录,如以下示例所示。 在Javadoc注释注释中使用at符号(@)并非偶然:它们在概念上相关。...Java语言规范列出了两:不推荐使用和未选中。泛型出现之前编写的旧代码进行交互时,可能会发生未经检查的警告。...使用此注释类型时,将抑制varargs使用有关的未经检查的警告。 5....@记录 @Documented注释表示,每当使用指定的注释时,都应使用Javadoc工具记录这些元素。(默认情况下,Javadoc中不包含注释。) 3.

1.5K10
领券