Pycharm文档模板变量

点击这里查看JetBrains官方英文源文件

本篇Blog只是搬运外加大概翻译一下。

File template variables

A file template can contain variables, which are replaced by their values when the template is applied. A variable is a string that starts with a dollar sign $ followed by the variable name. The variable name may optionally be enclosed in curly braces. For example: $MyVariable and ${MyVariable} are different notations of the same variable.

文档模板变量

文档模板可以包含变量,应用模板后,这些变量可以被它们的值替换。一个变量就是一个字符串,这个字符串以一个dollar符”$”开始后接变量名。变量名可以选择用大括号”{}”括起来。如:$MyVariable和${MyVariable}是相同的变量但符号不同。

Predefined template variables

The following predefined variables can be used in file templates:

Variable Description
${DATE} Current system date
${DAY} Current day of the month
${DS} Dollar sign $. This variable is used to escape the dollar character, so that it is not treated as a prefix of a template variable.
${FILE_NAME} Name of the new file
${HOUR} Current hour
${MINUTE} Current minute
${MONTH} Current month
${MONTH_NAME_FULL} Full name of the current month(January, February, and so on)
${MONTH_NAME_SHORT} First three letters of the current month name(Jan, Feb, and so on)
${NAME} Name of the new entity(file, class, interface, and so on)
${ORGANIZATION_NAME} Name of your organization specified in the project settings(Ctrl+Shift+Alt+S)
${PRODUCT_NAME} Name of the IDE(for example, PyCharm)
${PROJECT_NAME} Name of the current project
${TIME} Current system time
${USER} Login name of the current user
${YEAR} Current year

预设模板变量

下表预设的变量可用在文档模板中:

变量 描述
${DATE} 当前系统日期
${DAY} 某个月的当前日
${DS} Dollar符$。这个变量用来转义dollar字符,这样它就不会被视为模板变量的前缀
${FILE_NAME} 新文件的名称
${HOUR} 当前小时
${MINUTE} 当前分钟
${MONTH} 当前月份
${MONTH_NAME_FULL} 当前月份的全称(January, February, 依此类推)
${MONTH_NAME_SHORT} 当前月份名称的头三个字母(Jan, Feb, 依此类推)
${NAME} 新实体的名称(文档,类,界面,依此类推)
${ORGANIZATION_NAME} 在项目设定中指定的单位名称(Ctrl+Shift+Alt+S)
${PRODUCT_NAME} IDE名称(如:PyCharm)
${PROJECT_NAME} 当前的项目名
${TIME} 当前系统时间
${USER} 当前用户的登录名
${YEAR} 当前年份

Custom template variables

Besides predefined template variables, it is possible to specify custom variables. If necessary, you can define the values of custom variables right in the template using the #set directive.

For example, if you want to use your full name instead of your login name defined through the predefined variable ${USER}, use the following construct:

#set( $MyName = "John Smith" )

If the value of a variable is not defined in the template, PyCharm will ask you to specify it when the template is applied.

定制的模板变量

除了预设定的模板变量,定制的变量也是可以的。必要的话,你可以在模板中使用#set指令自定义一些变量的值。

举例,如果你想通过预设变量${USER}用你的全名替代你的登录名,就使用下面的语法结构:

#set( $MyName = "John Smith" )

在模板中,如果变量的值没有定义的话,当模板应用后PyCharm会要求你进行设定。



下面我们用PyCharm看下实例

原文地址:https://www.cnblogs.com/infinitecodes/p/11444051.html

时间: 2024-07-31 21:08:59

Pycharm文档模板变量的相关文章

新建文档模板是什么格式

新建文档模板,就是一个HTML文件.您可以用html制作表单,然后在用户保存的时候,将用户输入的内容重新组织成一个HTML文件,保存到Wiz里面. 一些例子 新建日记的模板:Wiz安装目录下面的templates\new\journal.htm文件 每日回顾模板:Wiz安装目录下面的templates\new\daily_review.htm文件 您可以使用文本编辑器或者html编辑器打开这些文件(不要用word/wps之类的字处理软件打开). 例如我用Visual Studio 编写了一个ht

“Word自动更改后的内容保存到通用文档模板上。是否加载该模板?“的解决办法

在win7系统下,Word2010出现了不能正常关闭.打开一个已有word文档,点击右上角关闭按钮后,先提示"word已停止工作,windows正在检查该问题的解决方案",随后提示"Microsoft word正试图恢复您的信息,这可能需要几分钟",最后提示"Microsoft Word已停止工作,出现了一个问题,导致程序停止正常工作.如果有可用的解决方案,Windows将关闭程序并通知您".之后,再重新打开word时,提示"Word自

VC++环境下多文档模板应用程序开发(带源码)

我们以前见到的关于VC++环境下利用APP Wizard 自动生成的MDI的应用程序只支持打开同一文档类型的多个文件,但是不能够同时打开不同种类型的文档.网上的这种公开资料比较少,我在知网上查阅了相关的资料.下面我根据这些资料做一下总结(辛辛苦苦一个一个字码出来的). 下面设计一个能够处理两种文档类型的应用程序:第一种文档类型:TXT文档,第二种文档类型:Bub的文档类型. 第一种的文档类型TXT,是利用APP Wizard自动生成的,只不过是在设置的时候将文档类型设置为TXT类型,并且使生成的

DDD领域驱动设计 - 设计文档模板

设计文档模板: 系统背景和定位 需求描述 系统用例图 关键业务流程图 领域语言整理,主要是整理领域中的各种术语的定义,名词解释 领域划分(分析出子域.核心域.支撑域) 每个子域的领域模型设计(实体.值对象.聚合.领域事件,需要注意的是:领域模型是需要抽象的,要分析业务本质,而不是简单的直接对需求进行建模) 领域模型详细说明(如为什么这样设计的原因.模型内对象的关系.各种业务规则.数据一致性规则等) 领域服务.仓储.工厂设计 Saga流程设计 场景走查(讲述如何通过领域模型.领域服务.仓储.Sag

自定义WIZ文档模板

WIZ文档模板 1.在wiz笔记里面新建一个笔记,并将其做成一个模板 例子: 2.该作为模板的笔记制作完成后,右键-高级-另存为  导出为html格式 3.将导出的文件和文件夹(有时候只有一个htm文件,有时候会多一个资源文件夹)一起添加到压缩文件夹 zip格式 4.更改刚才的zip后缀为ziw,并将其拷贝到  XXX\WizNote\templates\new 目录下 5.重启wiz笔记,在新建笔记里面即可看到新加入的模板. 来自为知笔记(Wiz)

软件系统设计文档模板

各位同学: 课程作业:软件设计说明书模板链接: 链接:http://pan.baidu.com/s/1cJmTFS 密码:joqv 主要内容如下,请各位同行批评指正. 四川师范大学 软件设计说明书 XXXX系统软件设计说明书 团队名称 [日期] 目录 文档变更记录... 0 引言... 0 1.1         项目介绍... 0 1.2         开发团队... 0 1.3         使用的文字处理和绘图工具... 0 静态体系设计... 0 2.1         全局数据结构

Mac系统之文档模板

以下的模板适合用来写使用性的文档(短篇文档), 内容如下, % XeLaTeX can use any Mac OS X font. See the setromanfont command below. % Input to XeLaTeX is full Unicode, so Unicode characters can be typed directly into the source. % The next lines tell TeXShop to typeset with xela

五分钟轻松搞定产品需求文档!这可能史上最全PRD文档模板

本文由  @JustWu 原创发布于社区 为什么写这篇文章? 第一:写PMCAFF的PRD文档,大家都是用户,比较好参考与理解,方便大家来找我写的不好的地方. 第二:我在自学PRD文档的编写过程中,总是遇到PRD文档里的对应产品总是找不到或是下架的情况,很难找到比较全面以及详细的参考模板,故一气之下撸了一篇,写好分享之. 关于这篇文章: 1.PRD本来就没有固定的版式,根据团队以及个人的需求有所差别,本篇力求简单,不累述. 2.这篇PRD可以再写的详细些,因为怕内容太多阅读太麻烦,对于需求说明以

常用接口文档模板

接口规范说起来大,其实也就那么几个部分,接口规范.接口管理工具.接口文档编写.开发文档编写.以下将详细介绍,下面进入正文: 接口规范文档 具体内容如下: 一:协议规范 二:域名规范 三:版本控制规范 四:API路径规范 五:API命名规范 六:请求参数规范 七:列表请求特殊规范 八:返回数据规范 九:接口文档规范 十:接口管理工具使用教程 参与编写 更新日期 版本 备注 AbyssKitty 2018/04/06 V1.1.0 无 V1.1.0更新日志: 1. 新增协议规范.域名规范.版本控制规