0

0

sql中注释的写法有哪些_mysql注释语法说明

P粉602998670

P粉602998670

发布时间:2026-01-28 11:33:09

|

247人浏览过

|

来源于php中文网

原创

MySQL注释分SQL语句级(--、#、/ /,不执行)和元数据级(COMMENT,存information_schema),混用易出错;COMMENT字段修改需保持原类型完整,验证须查系统表。

sql中注释的写法有哪些_mysql注释语法说明

MySQL 中注释分两类:SQL 语句级注释(用于注释代码本身)和元数据级注释(用于表/字段的业务说明),二者用途、语法、存储位置完全不同,混用会导致预期外行为。

SQL 语句里的单行/多行注释怎么写

这是写在 SQL 脚本中、供人阅读、不参与执行的纯文本标记,MySQL 完全忽略它们。

  • -- 开头(注意后面必须有空格),直到行末: -- 这是一条注释
  • # 开头(MySQL 特有,也需空格),直到行末: # 仅 MySQL 支持这种写法
  • /* ... */ 包裹,支持跨行: /* 查询用户+统计,2025-12-29 */

⚠️ 常见错误:写成 --注释(缺空格)或 /*注释*/(无空格),部分客户端(如旧版 Navicat 或某些 CLI 模式)可能报错或截断;// 不是 MySQL 注释语法,会直接报错。

给表和字段加业务注释(COMMENT)的正确姿势

这类注释会写入 information_schema 元数据,被 Navicat、DataGrip、Laravel Schema、甚至部分 ORM 自动生成文档时读取,属于“可编程的注释”。

  • 建表时直接加:
    CREATE TABLE user (
      id INT PRIMARY KEY COMMENT '主键ID',
      name VARCHAR(50) COMMENT '用户真实姓名'
    ) COMMENT = '用户基础信息表';
  • 修改已有表注释:ALTER TABLE user COMMENT = '更新后的用户主表';
  • 修改字段注释(必须重写字段定义):ALTER TABLE user MODIFY COLUMN name VARCHAR(50) COMMENT '用户全名(含姓氏)';

⚠️ 关键陷阱:修改字段注释时,MODIFY COLUMN 后面的字段类型必须和原类型完全一致(包括长度、是否 NULL、DEFAULT 等),否则会意外变更结构。例如原字段是 VARCHAR(50) NOT NULL,就不能只写 VARCHAR(50) COMMENT 'xxx',漏掉 NOT NULL 会导致该字段变成允许 NULL。

幻舟AI
幻舟AI

专为短片创作者打造的AI创作平台

下载

怎么验证注释是否生效

别只信 IDE 界面——有些工具缓存元数据,或不刷新字段注释。最可靠方式是查系统表:

  • 查某张表的注释:
    SELECT TABLE_COMMENT FROM information_schema.TABLES 
    WHERE TABLE_SCHEMA = 'your_db_name' AND TABLE_NAME = 'user';
  • 查某张表所有字段及注释:
    SELECT COLUMN_NAME, COLUMN_COMMENT 
    FROM information_schema.COLUMNS 
    WHERE TABLE_SCHEMA = 'your_db_name' AND TABLE_NAME = 'user';
  • 快速看完整建表语句(含所有 COMMENT):SHOW CREATE TABLE user;

Navicat 右键「设计表」看到的注释,本质也是查的同一套元数据;但如果刚执行完 ALTER 就立刻右键查看却没变,大概率是它没自动刷新,手动 F5 或重新连接即可。

真正容易被忽略的是:COMMENT 内容最长支持 2048 字符(MySQL 5.7+),但很多团队习惯写长段落甚至换行,而 MySQL 实际只存第一行(换行符会被截断或转义)。如果需要结构化描述,建议另建文档关联表名,而不是堆砌 COMMENT。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

319

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

278

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

372

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

374

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

85

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

65

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

68

2025.08.05

数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

707

2023.10.12

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

84

2026.01.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.9万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 812人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号