Хорошая норма подобна одежде, которую носит человек: какой бы красивой ни была красавица, если одежда будет небрежной и неуместной, темперамент всего человека сильно снизится.
Автор / Всемогущий Аксианг
Исходное время этой статьи: 2019-07-14
Эта статья занимает около 2 минут, чтобы прочитать
Каталог быстрого просмотра
- Причина написания этой статьи
- Во-вторых, спецификация контроля версий
- 3. Спецификация комментариев к коду
- В-четвертых, часто используемые советы PhpStorm
Причина написания этой статьи
Прошло уже почти 2 недели, как я пришел в новую компанию.Проект, которым я руковожу, написан на tp3.0.Привычный процесс действительно слишком болезненный.Нет документов,мало замечаний,нет записей о подаче версий и т.д. .(думаю все с этим сталкивались, тут не буду распространяться, хаха все знают QAQ)
В компании пока нет слишком нормативных вещей на этот счет.Чтобы сделать маленьких партнеров, которые вступят во владение в будущем менее болезненными, мы решили использовать некоторые нормативные вещи для себя, обслуживать себя и других, а в в то же время мы можем постепенно улучшать себя (ниже содержание частично организовано из Интернета)
Ну а теперь к делу ^_^
2. Спецификации контроля версий
Давайте сначала сделаем пример Когда мы отправляем информацию о версии каждый день, мы можем написать commit(svn|git) следующим образом:
feat(人员新增): 增加人员批量导入
- 增加批量报盘功能
- 增加人员报盘后结果查询功能
- 修改人员新增布局
На первый взгляд может быть непонятно, как выглядит формат подачи, так что давайте посмотрим
Содержимое определенного формата (студенты, использующие git, могут видеть этоcommitizen)
<type>(<scope>):这里是个空格<subject>
<BLANK LINE>这是空行不用写内容
<body>
<BLANK LINE> 这也是空行不用写内容
<footer>
Описание полей формата, упомянутых выше
- type 表示提交类别，具体内容如下(可以根据项目具体定义):
* feat: 添加新特性
* fix: 修复bug
* docs: 仅仅修改了文档
* style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
* refactor: 代码重构，没有加新功能或者修复bug
* perf: 优化相关，比如提升性能、体验
* test: 增加测试用例
* chore: 改变构建流程、或者增加依赖库、工具等
* revert: 回滚到上一个版本
- scope 表示修改范围,非必填（建议填写）
- subject 标题
- body 提交内容主体的具体描述内容
3. Спецификация комментариев к коду
Разработано мнойPhpStorm, аннотации в основном основаны наPhpStormизLive TemplatesШаблоны генерируются быстро(Шаблон переменная чит)
Во-первых, взгляните на картинку и обратите внимание на специфический эффект: выглядит очень освежающе?
Ниже приведены наиболее часто используемые имена аннотаций в аннотациях, выбирайте в соответствии с вашими потребностями.
/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析，不出现在文挡中
* @final 指明这是一个最终的类、方法、属性，禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量，并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/
В-четвертых, навыки улучшения PhpStorm
Соединенные Штаты так важны, потому что сердце красоты в каждом. И для людей, и для текста, это так.
Прикрепите конфигурации, быстро генерируйте комментарии, но конфигурация маленького партнера быстро попробуйте, это не очень близко, не забудьте открыть большое изображение, о
(Примечание: Код быстро генерируется с помощью IDE, я считаю, что все очень "ленивы", поэтому не набирают столько руками, как утомительно ха-ха)
--------------------------------------------- Великолепная разделительная линия- - -------------------------------------------------- -----
Старик - сумасшедший подросток
случайно, не та строка
Заброшенные в него два обширных слеза
Теплое напоминание Сяна: не забудьте сделать перерыв после прочтения и будьте полны энергии сегодня.
Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь общаться
THE END ^_^