在sublime3(2)中生成类或者方法的注释

最新推荐文章于 2021-05-23 19:52:00 发布
原创 最新推荐文章于 2021-05-23 19:52:00 发布 · 3.3k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文介绍了如何在Sublime Text中安装PackageControl和DocBlockr插件，以便自动生成PHP文档注释。适用于JavaScript、PHP、ActionScript等语言。

1、首先在sublime安装Package Control，具体可以参考：如何安装Package Control；

2、安装完Package Control以后，重启sublime；

3、step1：Preferences -> Package Control；

      step2：框内输入命令Install Package回车；

      step3：继续在框内输入DocBlockr，选中需要的后安装即可。

      具体可以参考：如何安装DocBlockr

备注：DocBlockr可以自动生成PHPDoc风格的注释。它支持的语言有Javascript, PHP, ActionScript, CoffeeScript, Java, Objective C, C, C++。只需要在函数上面输入/** ,然后按tab 就会自动生成注释。

wcjwdq
关注
Sublime-自定义生成作者等头注释的方法-file header
Min的博客
07-14 8138
Sublime是一个很便捷的代码编辑器，其中很多好用的插件，插件的安装方法也有很多，我采用的是Package Control组件安装（推荐），这篇主要说的是插件file header，默认你已经安装好package control。一、安装file header插件1、默认已经安装好package control组件2、步骤：点击Package Control或者直接Shift+Commamd+P...
Sublime自定义Lua代码段Snippet包（Lua函数注释）
03-16
生成带注释的函数，能自动按照参数生成注释行（dfun.sublime-snippet） 使用：用sublime打开Default (Windows).sublime-keymap文件，将里面快捷键Ctrl+Alt+x复制到自己的sublime的快捷键文件内
sublime3 docblocker插件定制自己的注释，配置步骤
热门推荐
hardgirls的博客
08-21 3万+
用DocBlockr写更好看的注释 By Frank Fan  发表于 2016-02-05 文章目录 DocBlockr很好用，不仅仅可以自动生成注释，还可以手动控制注释的格式。 安装方法： Cmd+Shift+P -> Install Package -> docblockr 自定义配置： Preference -> Package Settings -> DocBlock
sublime3快速生成类或者方法的注释
wephper
07-21 3226
1、首先在sublime安装Package Control，具体可以参考：如何安装Package Control； 2、安装完Package Control以后，重启sublime； 3、step1：Preferences -> Package Control；       step2：框内输入命令Install Package回车；       step3：继续在框内输入DocBlock
sublime text3对函数的快捷注释说明
致希望与理想
08-27 3616
对sublime text3的函数快捷注释键 使用sublime版本为 官方的3.2.1 Build3207 先输入/** 然后按Tab /** public function addMenu($dd){ var_dump($dd); $change = new Material; $change->createMenu(); } 效果如图显示,这里注意,sublim...
Sublime Text3 自动生成注释 作者名+时间
i逆天耗子
04-18 2万+
Step1: 需要使用组合键command+shift+p 搜索Install Package 后回车 确定 Step2: 经过上一步回车后到达第二步（可能需要等待一会儿）,会出现搜索框，搜索DocBlockr 回车进行安装 Step3: 安装成功后如图进行配置(左下角有左右移动的= 表示正在安装) Step4: 输入代码如图所示 如图所示表示正在...
sublime3 文件头注释和函数注释 [ filehead DocBlocker ]
u014474674的博客
10-21 4629
首先需要先安装package control 参考  http://blog.youkuaiyun.com/kongguyoulan523/article/details/51144254  使用插件  FileHeader  https://github.com/shiyanhui/FileHeader   里面有安装说明 安装好了后如何自定义文件头： 找到FileHead
sublime text3 SublimeTmpl
10-21
如果没有安装Package Control，首先需要在Sublime Text 3中安装这个管理器，然后通过它来搜索并安装`SublimeTmpl`。 2. **配置问题**：`SublimeTmpl`需要在用户设置中进行配置，以指定模板文件的存储位置。如果未...
SublimeText3中文全插件.rar
01-21
Sublime Text 3是一款广受开发者喜爱的源代码编辑器，尤其在前端开发领域中备受推崇。这款轻量级但功能强大的编辑器以其高效的性能、丰富的插件系统和高度自定义性著称。"SublimeText3中文全插件.rar"这个压缩包包含...
精选资源
mypy_boto3_builder：与VSCode，PyCharm，Emacs，Sublime Text，pyright和mypy兼容的boto3的类型注释生成器
02-05
为项目键入注释生成器。 与 ， ， ， ， ， 等工具。 了解如何帮助查找和修复潜在的错误： 使用boto3存根 检查项目以获取安装和使用说明。 如果您使用最新的boto3版本，只需安装相应的boto3-stubs然后开始使用...
sublime text3 快速生成注释
weixin_34227447的博客
05-03 2539
为什么80%的码农都做不了架构师？>>> ...
Sublime text 设置类注释或者方法注释
xiaoai5324的专栏
07-30 3168
1、选择preferences 2、选择package control  3、输入install package，回车 4、输入docblockr，回车 自动安装完成之后，只需要在类前面或者方法前输入/**然后tab就可以了 ...
Sublime Text3下，实现函数声明的跳转
iGaming
03-26 1万+
用了ST3很久，觉得这编辑器特别顺手好用。项目是Cocos2d-x + Lua。可惜的是，ST3不支持函数声明间的跳转，然而我找到了一个插件——CTags，可以完美支持这一功能。装上这个插件后，剩下的遗憾就是ST3不能像CocosIDE那样，有实时的API提示了。 如果，你下载了CTags插件，但是一按Rebuild Tags却弹出乱码框，按下面步骤走一次，就会顺利解决了~ 来
在sublime中写注释的规范
woshinannan的专栏
01-14 3617
//写一个函数或者类的注释 /** *@author 作者 [name] ]> *@param 参数 格式为 {String} 参数描述 [type] $[name] [] *@example 例子 [URI] [] *@link 链接 格式 (target, link) *@namespace *@requires *@return 返回值 [type] [] *@ver
sublime跳转到函数定义
CyborgLin的博客
04-23 1万+
sublime跳转到函数定义
sublime 设置php自动添加函数注释
红豆随手记
08-11 891
1：打开sublime 按快捷键Ctrl + `或者View->Show Console，复制粘贴如下代码 import urllib.request,os,hashlib; h = '7183a2d3e96f11eeadd761d777e62404' + 'e330c659d4bb41d3bdf022e94cab3cd0'; pf = 'Package Control.sublime-package'; ipp = sublime.installed_packages_path(); ur...
Sublime Text 3使用手册
weixin_33671935的博客
04-14 479
Sublime Text 3中文优化版下载地址：http://pan.baidu.com/s/1kU72y4B 密码:ad52 【安装完成之后，可在安装根目录找到"系统鼠标右键菜单.bat"添加鼠标右键以sublime打开的功能。】 --------------- 【最常用的】： 1、新建文件-输入"html:xt"后 按"Ctrl+E键"或 "tab键" ,可快速生成xhtml ...
Sublime 快速生成结构代码
succuba_ckr的博客
08-15 9564
今天第一天系统学习前端知识。看了个视频，目前比较流行用的前端开发软件是sublime。于是，我就安装了。但是问题来了，我跟着视频里的操作，快速生成代码，结果发现，根本不听招呼。于是我就查。 晚上有好多种快速生成结构代码的方式，我一一尝试，都失败告终。后来发现一点，所有的方式都需要tab键。后来我突然意识到，可能是我的tab键和人家的不一样。于是，我就开始搜。 最后我确定了问题所在。即我没有安装...
sublime text3 快速生成方法注释
我的博客
05-23 353
安装插件：Cmd+Shi...
sublime text3匹配中文注释的正则表达式
最新发布
07-24
<think>我们正在使用Sublime Text3，并且需要匹配中文注释。在编程中，注释通常以特定的符号开头，比如在JavaScript中可能是`//`或`/* */`，在HTML中是`<!-- -->`，在Python中是`#`或`&#39;&#39;&#39;`等。但是，用户没有指定具体的编程语言，所以我们考虑一般情况。 然而，用户提到了“中文注释”，所以我们需要匹配包含中文字符的注释。因此，我们可以分为两步： 1. 匹配注释的格式（根据不同的语言可能不同，但用户没有指定，所以我们可能需要一个通用的方法，或者考虑多种注释形式） 2. 在匹配到的注释中，要求包含中文字符。 但是，用户要求的是在Sublime Text3中使用正则表达式，所以我们可以尝试匹配同时满足以下两个条件的文本： - 是注释（即包含注释符号） - 包含中文字符 由于不同语言的注释符号不同，我们可以考虑设计一个匹配多种注释形式的正则表达式，或者针对用户当前使用的文件类型来设计。但用户没有说明，所以我们给出一个通用的思路，并给出一个示例（比如以常见的几种注释形式为例）。 另外，在Sublime Text3中，我们可以通过正则表达式搜索功能来查找。 思路： 我们可以使用一个正则表达式，它由两部分组成： a. 匹配注释的开始符号（例如：//, /*, <!--, # 等）到注释的结束符号（如果有的话，如 */, -->）或者到行尾（对于单行注释）。 b. 在注释的内容部分，必须包含至少一个中文字符。 但是，由于不同注释的格式不同，我们可以分别考虑： 情况1：单行注释（如//, #） - 从注释符号开始，到行尾，且中间某处包含中文字符。 情况2：多行注释（如/* ... */, <!-- ... -->） - 匹配从开始符号（/*或<!--）到结束符号（*/或-->）之间的内容，且中间包含中文字符。 由于正则表达式需要同时覆盖多种情况，我们可以使用“或”操作符（|）来组合。 但是，一个正则表达式同时匹配多种注释形式可能会比较复杂，而且容易出错。因此，我们可以分多次搜索，或者根据当前文件类型选择对应的注释形式。 这里，我们假设用户需要同时匹配多种注释形式，我们设计一个正则表达式来覆盖常见的注释： 常见注释形式： 1. `// 单行注释` 或 `# 单行注释` 2. `/* 多行注释 */` 3. `<!-- 多行注释 -->` 我们设计正则表达式如下： 第一部分：匹配单行注释（以//或#开头，到行尾）且包含中文字符 - 单行注释的正则：`(//|#)[^\n]*[\u4e00-\u9fa5]+[^\n]*` 第二部分：匹配多行注释（包括/*...*/和<!--...-->）且包含中文字符 - 对于`/* ... */`：`/\*[\s\S]*?[\u4e00-\u9fa5]+[\s\S]*?\*/` - 对于`<!-- ... -->`：`<!--[\s\S]*?[\u4e00-\u9fa5]+[\s\S]*?-->` 将这三部分合并，用“或”连接： 最终正则表达式（未考虑效率）： `(//|#)[^\n]*[\u4e00-\u9fa5]+[^\n]*|/\*[\s\S]*?[\u4e00-\u9fa5]+[\s\S]*?\*/|<!--[\s\S]*?[\u4e00-\u9fa5]+[\s\S]*?-->` 注意： - 我们使用了`[\u4e00-\u9fa5]`来匹配一个中文字符（基本汉字），如果需要更全面的汉字，可以替换为更宽的范围或使用Unicode属性（但Sublime Text3可能不支持Unicode属性转义）。 - 在Sublime Text3中，正则表达式引擎是支持Unicode的，所以可以使用`\u`。 但是，这个正则表达式可能会匹配到包含中文字符的注释，但它也会匹配整个注释（包括注释符号）。如果只想高亮注释中的中文部分，这个表达式就不合适了。不过，用户要求的是匹配中文注释（即整个注释块），所以这样是可以的。 另外，这个正则表达式在匹配多行注释时，使用了非贪婪匹配`*?`，以避免跨注释块的匹配。 然而，由于Sublime Text3的搜索是在当前文件中进行的，所以这个正则表达式可以工作。 但是，我们也要注意，有些注释可能跨越多行，比如单行注释实际上可能有多行（多个连续的//注释），但我们的单行注释部分只能匹配一行。不过，如果一行单行注释包含中文，我们就匹配这一行。对于多行连续的//注释，每一行都是独立的，所以这样处理是合理的。 另外，多行注释部分，我们使用`[\s\S]*?`来匹配任意字符（包括换行）的非贪婪模式，以确保匹配到第一个结束符号。 但是，这个正则表达式可能较长，而且效率可能不是最优，但对于一般文件应该是可以接受的。 因此，我们可以在Sublime Text3中这样使用： 1. 打开搜索面板（Ctrl+F 或 Cmd+F） 2. 点击左侧的`.*`按钮（或者使用Alt+R）启用正则表达式模式 3. 在搜索框中输入上述正则表达式 但是，如果用户使用的是特定语言，可能只需要其中一种或两种注释形式，那么可以简化。 另外，如果用户想要匹配所有包含中文的注释（而不考虑注释符号），那么我们可以简单匹配注释中的中文，但是这样可能会匹配到非注释部分的中文（比如字符串中的中文）。所以，我们还是要结合注释符号。 因此，我们给出一个更通用的版本，并考虑到扩展汉字（如扩展A区、B区等）的情况，我们可以使用扩展的汉字范围： 将`[\u4e00-\u9fa5]`替换为：`[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]` 所以，最终的正则表达式为： ``` (//|#)[^\n]*[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[^\n]*|/\*[\s\S]*?[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[\s\S]*?\*/|<!--[\s\S]*?[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[\s\S]*?--> ``` 注意：这个正则表达式可能会匹配到包含至少一个汉字的注释，如果一行注释中有多个汉字，它也会匹配。 但是，如果注释中不包含汉字，则不会匹配。 另外，这个正则表达式在匹配多行注释时，要求注释中至少有一个汉字，并且会匹配整个注释块（从开始符号到结束符号）。 在Sublime Text3中，我们可以使用这个正则表达式来查找所有包含中文的注释。 然而，由于正则表达式较长，我们可以将其拆分为多行并添加注释（在Sublime Text中不支持正则表达式中的注释，所以这里只做说明）： 实际使用中，我们直接输入整个字符串。 示例： 假设我们有以下文本： ```javascript // 这是一个中文注释 var str = "字符串"; // 这里也有中文注释 /* 这是多行注释，包含中文 */ /* 这是多行注释，但不包含中文 */ <!-- 这里是HTML注释，有中文 --> # 这是Python风格的中文注释 ``` 使用上面的正则表达式，将匹配除了`/* 这是多行注释，但不包含中文 */`之外的所有注释（因为这一条没有中文字符）。 但是，注意第二条注释：`// 这里也有中文注释`，它会被匹配。 但是，注意第二条注释是在代码后面的，我们正则表达式的单行注释部分会匹配从`//`开始到行尾，所以整行都会被匹配。如果我们只想匹配注释部分（不包括前面的代码），那么我们的正则表达式已经做到了，因为它从`//`开始。 但是，在Sublime Text3中，搜索会高亮整个匹配的文本，也就是整个注释（包括符号和内容）。 如果用户只想高亮注释中的中文部分，那么就需要修改正则表达式，使用捕获组或者只匹配中文部分。但是，用户的问题是要匹配中文注释（整个注释块），所以我们这样设计。 因此，我们推荐使用上述正则表达式。 但是，我们也要注意，有些语言可能有不同的注释符号，比如SQL使用`--`。如果用户需要，可以自行添加到单行注释部分。例如，将`(//|#)`改为`(//|#|--)`。但是，要注意`--`可能出现在其他上下文中（比如减减操作符），但在注释中，它通常出现在行首或前面有空白。不过，为了简单，我们只考虑注释符号出现在行首的情况？不一定，因为行内注释也可以。所以，我们可能需要更精确的匹配。 但是，由于用户没有指定语言，我们按照常见情况处理。用户可以根据需要修改。 所以，我们总结： 在Sublime Text3中，使用以下正则表达式可以匹配三种常见形式（//, #, /* */, <!-- -->）的包含中文的注释： ``` (//|#)[^\n]*[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[^\n]*|/\*[\s\S]*?[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[\s\S]*?\*/|<!--[\s\S]*?[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[\s\S]*?--> ``` 如果还需要其他注释形式，可以自行添加。 注意：这个正则表达式在匹配多行注释时，要求注释中至少有一个汉字，并且会匹配整个注释块（从开始到结束）。如果多行注释中没有汉字，则不会匹配。 另外，如果单行注释中不包含汉字，也不会匹配。 最后，我们提醒用户，在Sublime Text3中，正则表达式默认是区分大小写的，但注释符号通常是小写，所以没有问题。 如果用户需要不区分大小写，可以勾选搜索面板中的“Case Sensitive”按钮（使其不选中），但我们的正则表达式中没有字母大小写的问题，因为注释符号都是特定的符号。 因此，我们给出上述答案。 如果用户有特定的语言，建议根据语言调整。 另外，如果用户想要匹配更精确的汉字（包括扩展区），并且使用Unicode属性转义，但Sublime Text3可能不支持ES2018的`\p{Script=Han}`，所以这里我们使用扩展的Unicode范围。 如果用户使用的是Sublime Text4（如果支持Unicode属性转义），那么可以使用`\p{Han}`（注意：`\p{Script=Han}`可以简写为`\p{Han}`），但需要确认Sublime Text的正则引擎是否支持。根据目前了解，Sublime Text3使用的正则引擎是Boost.Regex，它支持Unicode属性，但语法可能不同。 经过查阅，Boost.Regex支持`\p{Han}`，但需要启用Unicode支持。在Sublime Text3中，我们无法直接添加标志，所以可能无法使用。因此，我们还是使用Unicode范围的方式。 所以，我们保留上述正则表达式。 如果用户需要，我们可以提供更精确的汉字范围，但上述范围已经覆盖了大部分情况。 因此，我们推荐使用上述正则表达式。 注意：在Sublime Text3中，多行匹配需要确保点号不匹配换行，但我们使用了`[\s\S]`来匹配任意字符，包括换行，所以可以跨行匹配多行注释。 最后，我们给出一个示例： 在Sublime Text3中，打开一个文件，按Ctrl+F，然后点击`.*`，在搜索框中输入： ``` (//|#)[^\n]*[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[^\n]*|/\*[\s\S]*?[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[\s\S]*?\*/|<!--[\s\S]*?[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+[\s\S]*?--> ``` 然后就可以查找所有匹配的中文注释了。 如果匹配不到，请检查： - 文件编码是否为UTF-8 - 正则表达式是否正确复制（注意没有换行） 希望这个回答能够帮助用户。 如果用户需要，我们还可以提供更具体的针对某种语言的注释匹配。 生成相关问题： §§相关问题§§ 1. 如何用正则表达式匹配包含中文的字符串（非注释）？ 2. Sublime Text3中如何通过正则表达式批量删除中文注释？ 3. 如何匹配不同编程语言中的注释？</think>在 Sublime Text3 中匹配中文注释，需要结合注释符号和中文字符的正则表达式。以下是针对不同编程语言的解决方案： ### 通用解决方案（推荐） ```regex (//|#|--|<!--|/\*)[^\n]*?[\u4e00-\u9fa5]+.*?(?:\n|\*/|-->) ``` **解释**： 1. `(//|#|--|<!--|/\*)`：匹配常见注释符号 - `//`：JS/Java/C++ 单行注释 - `#`：Python/Ruby 注释 - `--`：SQL 注释 - `<!--`：HTML 注释开始 - `/\*`：多行注释开始 2. `[^\n]*?`：匹配任意非换行字符（非贪婪模式） 3. `[\u4e00-\u9fa5]+`：匹配至少一个中文字符 4. `.*?`：匹配注释剩余内容 5. `(?:\n|\*/|-->)`：匹配注释结束标记 - `\n`：单行注释结束 - `\*/`：多行注释结束 - `-->`：HTML注释结束 ### 分语言解决方案 #### 1. JavaScript/Java/C++ 单行注释 ```regex //[^\n]*?[\u4e00-\u9fa5]+[^\n]* ``` **匹配示例**： ```javascript // 这是一个中文注释 const x = 1; // 带中文的行内注释 ``` #### 2. Python/Ruby 注释 ```regex #[^\n]*?[\u4e00-\u9fa5]+[^\n]* ``` **匹配示例**： ```python # 中文注释示例 def func(): # 函数说明 ``` #### 3. SQL 注释 ```regex --[^\n]*?[\u4e00-\u9fa5]+[^\n]* ``` **匹配示例**： ```sql SELECT * FROM table -- 这是中文注释 ``` #### 4. HTML 注释 ```regex <!--[\s\S]*?[\u4e00-\u9fa5]+[\s\S]*?--> ``` **匹配示例**： ```html <!-- 多行中文注释 第二行内容 --> ``` #### 5. CSS/多行注释 ```regex /\*[\s\S]*?[\u4e00-\u9fa5]+[\s\S]*?\*/ ``` **匹配示例**： ```css /* 中文注释 跨行示例 */ ``` ### 使用步骤（Sublime Text3） 1. 打开搜索面板：`Ctrl + F` 2. 启用正则模式：点击左侧 `.*` 按钮 3. 粘贴正则表达式到搜索框 4. 勾选 "Regular Expression" 选项 5. 点击 "Find All" 查找所有匹配项 ### 高级技巧 1. **扩展汉字支持**（如生僻字）： ```regex //[^\n]*?[\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]+ ``` 覆盖扩展汉字区（如𠮷, 𡈽等）[^1] 2. **排除误匹配**： ```regex (^|[^\\])//[^\n]*?[\u4e00-\u9fa5]+ ``` 避免匹配被转义的注释（如：`http://`） 3. **批量删除中文注释**： ```regex (//|#|--|<!--|/\*)[^\n]*?[\u4e00-\u9fa5]+.*?(?:\n|\*/|-->) ``` 替换为空内容即可删除 > **提示**：在 Sublime Text3 中使用 `Alt + R` 可快速切换正则匹配模式[^3]。匹配结果会高亮显示，按 `F3` 可逐个跳转查看。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值