-
2020-12-19 08:30:52
技术文档
主体内容:可以认为是页面最想表达的内容总和。对于内容详情页来说,主体内容指从标题开始至正文内容结束,翻页区域也被视为主体内容,文章后的评论、分享、推荐等不视为主体内容。
首屏:用户点击搜索结果后进入移动页面,不滑动屏幕即看到的所有内容,称为首屏。
一屏:用户滑动屏幕至主体内容展现结束之前,在页面任意位置停留时看到的所有内容,称为一屏。
移动端适配:为了使PC页面能够在移动端正常展现的手段,保证用户不需要缩小、放大、左右滑动即可看清全部字体。
列表页:指信息聚合展示的页面,包括图片列表页、问答列表页、文章列表页、黄页信息列表页等。
详情页:指信息全部展开显示的页面,包含文章内容页、问答详情页、商品详情页等。
广告:指为了某种特定的需要,通过一定形式的媒体,公开且广泛地向公众传递信息的宣传手段;本白皮书中的广告泛指所有在落地页中出现的面向用户的传播行为。需要注意的是,对网站自有产品的推广也视作广告。
APP引导:引导用户下载安装或激活调起APP的行为,包括大段文字、图片、弹窗浮窗等形式。百度移动搜索为了降低用户获取内容的成本,要求凡可在H5端观看、操作的内容及功能,均不可引导甚至强制用户下载APP来解决。
一跳页面:从百度搜索结果点击进入落地页时,进行第一次跳转后到达的页面。
多跳页面:从百度搜索结果点击进入落地页后,进行二次或多次跳转所到达的页面。
页面加载速度是影响用户搜索体验的一个重要因素。百度搜索对用户行为的研究表明,页面首屏的加载时间在1.5秒以内的网站,会带给用户流畅快捷的极速体验。
从搜索结果页进入站点落地页的一跳以及多跳页面都应有加载动效。
在页面加载等待的过程中,应有加载动效及时反馈(如页面自右向左滑动进入等),带给用户优质高级的感受
页面字体、字符大小、文本行间距等设计,应适合手机用户阅读,不可明显过大过小,正文文本字号不小于10pt。
更多相关内容 -
Android Studio 实现文档注释的快捷键
2020-08-19 12:30:34主要介绍了Android Studio 实现文档注释的快捷键,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧 -
java文档注释模板(个性化设置,包括颜色设置)
2018-06-10 17:24:20这个是java文档注释模板,使用myeclipse创建的,里面添加了基本颜色,只需导进到开发工具就可以了 -
vscode-docomment:生成Visual Studio Code的XML文档注释
2021-05-02 16:32:34XML文档注释对Visual Studio Code的支持 为Visual Studio Code生成XML文档注释。 弃用的公告 C# for Visual Studio Code (powered by OmniSharp)支持C# for Visual Studio Code (powered by OmniSharp)现在正式支持... -
tsdoc:TypeScript的文档注释标准
2021-02-04 23:15:55文档链接 -项目概述和路线图 -其他开发人员的实时帮助 -了解语法元素,如@param , @remarks等。 解析器引擎的交互式演示 -如何在此仓库中构建和调试项目 提出拉取请求的说明 此monorepo中的项目 夹 版 变更日志 ... -
java文档注释要求
2019-02-21 10:16:34一个好的程序员工资的体现不仅仅在于技术的强弱,还体现在注释的书写上 -
MyEclipse、Eclipse代码文档注释模板
2018-09-07 17:25:321、Window---Preference---Java---Code Style---Code Templates 2、选择Comments---Import -
c#文档注释规范
2017-10-07 18:29:01C# 提供一种机制,使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中,具有某种格式的注释可用于指导某个工具根据这些...使用这类语法的注释称为文档注释 (documentation comment)。 -
VS c# 生成 文档 注释 源代码
2018-05-07 23:41:31使用说明:在项目-属性-生成-输出-输出XML文档注释。然后用本软件打开此文档。在datagrid按CTRL+A复制到Word。在word中选择表格-设计-选择任一模板,表格线就变单线了。 -
IDEA 设置文档注释
2021-01-22 11:24:59IDEA 设置文档注释 1、参考资料 IDEA类和方法注释模板设置(非常详细) idea注释模版配置(吐血推荐!!!) 2、类文档注释 2.1、设置类文档注释模板 在【File and Code Templates】页面设置类(Class)的文档注释...IDEA 设置文档注释
1、参考资料
2、类文档注释
2.1、设置类文档注释模板
在【File and Code Templates】页面设置类(Class)的文档注释
/** *@ClassName ${NAME} *@Description TODO *@Author ${USER} *@Date ${DATE} ${TIME} *@Version 1.0 */
2.2、使用类文档注释
注意:只有新建类的时候,才能创建类的文档注释哦
3、设置接口文档注释
3.1、设置接口文档注释模板
同样的方法,在【File and Code Templates】页面设置接口(Interface)的文档注释
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end #parse("File Header.java") /** *@InterfaceName ${NAME} *@Description TODO *@Author Oneby *@Date ${DATE} ${TIME} *@Version 1.0 */ public interface ${NAME} { }
3.2、使用接口文档注释
注意:只有新建接口的时候,才能创建接口的文档注释哦
4、方法文档注释
4.1、设置方法文档注释模板
-
在【Live Templates】中新建一个模板
-
默认会新建一个名为 user 的分组(我也懒得改名字了)
Abbreviation:*
表示在方法上输入*
,再敲击 Enter 就能出现方法文档注释- Description:为方法添加文档注释
- Template Text:模板内容
- Applicable in Java:仅在 Java 文件中生效
-
为模板上的变量添加默认值
-
方法文档注释的模板
** * @description: $description$ $params$ * @return: $returns$ * @author Oneby * @date: $date$ $time$ */
-
params
的default value
:groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())methodParameters())
4.2、使用方法文档注释
Nice~~~
-
-
Java 文档注释
2021-01-03 03:47:00Java 文档注释 Java 支持三种注释方式。前两种分别是 // 和 /* */,第三种被称作说明注释,它以 /** 开始,以 */结束。 说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出... -
Java文档注释 - IDEA设置
2022-01-06 11:13:58前两种分别是 单行注释 // 和 多行注释 /* */ ,第三种是 文档注释 /** */。 在IDEA中,文档注释可以对类、接口、方法、属性等进行描述,提高阅读效率。 文档注释只能写在类、接口、方法、属性等前面,否则无效。 ...一. 概述
Java支持三种注释。前两种分别是 单行注释 // 和 多行注释 /* */ ,第三种是 文档注释 /** */。
在IDEA中,文档注释可以对类、接口、方法、属性等进行描述,提高阅读效率。
文档注释只能写在类、接口、方法、属性等前面,否则无效。
二. 类注释
1. File -> Settings
2. Editor -> File and Code Templates -> Includes -> File Header
右侧写文档注释模板
3. 模板如下,设置保存后,创建类时,自动生成。
/** * @author: ${USER} * @date: ${DATE} ${TIME} * @description: */
三、方法注释
1. Editor -> Live Templates -> + -> Template Group
2. 填写模板名字
3. 选中"之前创建的模板" -> Live Template
4. 设置模板生成快捷键
1: 模板名,2:快捷键
1 和 2 设置后,生成快捷键为: / + 模板名 + 快捷键
5. 模板如下
** $param$ $return$ * @author: $user$ * @date: $date$ $time$ * @description: */
6. 设置模板应用场景 Define
(如果曾经修改过,则显示为change而不是define)
7. Everywhere -> Java
8. 设置参数的获取方式,Edit variables
9. 如图填写 (Expression下拉框选中)
param -> Default value
groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());
return -> Default value
groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());
全部完成之后,创建方法后,使用快捷键进行生成。
-
myeclipse/eclipse设置java文档注释
2017-01-16 20:46:00这份文档详细说明了myEclipse/Eclipse中是如何配置java文档注释的,每次在myEclipse/Eclipse中写java代码时就可以用同一的文档注释了,减少了手工注释的麻烦。 -
idea中类和方法创建文档注释
2021-11-08 19:49:41给类创建文档注释 第一步 打开idea ==> 点击file ==> 选择Settings (也可以用快捷键 Ctrl + Alt + S) 第二步 点击Editor ==> File and Code Templates ==> 找到Class 第三步 在右边 #parse()下面输入 ...一.给类创建文档注释
第一步
打开idea ==> 点击file ==> 选择Settings (也可以用快捷键 Ctrl + Alt + S)
第二步
点击Editor ==> File and Code Templates ==> 找到Class
第三步
在右边 #parse()下面输入
/** * *@author Tonny *@date ${DATE} ${TIME} *@version 2021.2 */
点击Apply就完成了
- @author为作者名
- @date为编写时间
- @version为你的软件版本号(不是JDK,我的idea是2021.2版本的)
第四步
我们新创建一个类就能看见我们写的文档注释了
二.用快捷键给类创建文档注释
第一步
打开idea ==> 点击file ==> 选择Settings (也可以用快捷键 Ctrl + Alt + S)
第二步
点击Editor ==> Live Templates ==> 点击右边加号选择第二个
(意思是创建一个新的组)
第三步
名字最好是命名为你的名称加Group,我这里命名为TonnyGroup(当然,你要叫其他的也没有问题) ==> 点击OK
第四步
选择你刚刚命名的组,点击右上角+号选择第一个
第五步
输入以下内容在输入框中:
/** * @author Tonny * @date $date$ $time$ * @version 2021.2 */
在Abbreviation中输入的内容就是你调出这个文档注释的快捷指令(我命名为了*c,你们觉得哪种舒服就怎样来,要记住)
在Description中输入,这个快捷指令的说明
第六步
点击Edit variables ==> 在Default value中分别输入 date() 和 time()
这里输入的date() 和 time() 的作用分别是获取日期和时间,输出的位置就是刚刚我们输入 @date d a t e date date t i m e time time 的地方
第七步
我们点击左下角的蓝字 ==> 把Java勾选上(Java下面的东西会自动全部勾选)
第八步
我们在 expand with 中选择Enter ==> 点击Apply就完成配置了
第九步
我们输入我们刚刚设置的快捷指令,在右边可以看到我们设置的说明,回车一下我们就正确的完成了这个配置过程
三.用快捷键给方法创建文档注释
这个配置过程和刚刚的用快捷键给类创建文档注释操作类似
第一步
我们刚刚不是创建了TonnyGroup吗?选择它,点击+号 ==> 点击第一个
(我这里已经创建好了)
第二步
我这里快捷指令和说明都写好了,你们觉得哪种好写哪种
输入以下内容在方框中
/** * @author Tonny * @Param $param$ * @return $return$ * @date $date$ $time$ */
第三步
点击Edit variables ==> 在Default value中分别输入以下内容 ==> 我们在 expand with 中选择Enter
第四步
我们点击左下角的蓝字 ==> 把Java勾选上(Java下面的东西会自动全部勾选)
==> 点击Apply就完成配置了
第五步
检查一下配置有没有完成
-
IDEA添加文档注释
2021-03-12 19:16:19多行注释和文档注释。 在编写代码时,我们经常添加文档注释,来记录代码的作用。 本文介绍三种常用的文档注释。 文档注释 在创建文件的时自动添加的注释内容,声明该文件的作用和创建时间。 打开设置 找到相应设置 ... -
Eclipse 的快捷键以及文档注释
2019-06-04 16:28:311.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/* */注释 3.以上快捷在重复按一下就会去掉加上的注释 4.要修改在eclispe中的... -
Java的文档注释之生成帮助文档的实例
2020-08-28 13:27:36下面小编就为大家分享一篇Java的文档注释之生成帮助文档的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧 -
IDEA如何添加文档注释
2021-01-27 20:57:46使用过程中想给类文件加个文档注释,总结了一下 1.设置过程 首先点击左上角的File-Setting-Editor-File and Code Templates 然后点击右面出现的的Includes-File Header 空白处添加想写的文档注释(下面有我个人用的... -
PyCharm 设置文档注释
2021-08-19 09:07:57PyCharm 设置文档注释 为了方便表示函数变量名、返回说明等说明信息,文档字符串格式设置。pycharm有内置注释模板。 (这边使用的是已汉化的pycharm) 1、打开设置(setting) 2、打开,工具(Tools) —>python... -
extract-documentation-comments:只需从源文件中提取文档注释
2021-02-13 07:52:16提取文档注释 只需从源文件中提取文档注释。 目录 背景 我创建这个项目是因为我觉得所有其他“解析源代码注释以生成文档”解决方案都无法满足我的需求。 是过时的,过时的,其假设使得很难在没有非常类似于C的语法... -
javadoc命令可以将文档注释提取出来生成帮助文档。
2021-03-01 06:56:43javadoc命令可以将文档注释提取出来生成帮助文档。今草是楷书的草写体,文档文档是在狂草的基础上,结合楷书书法发展起来的。关于情景故事法的“视觉化”环节,注释错误的理解是( )。生成哪一项不属于情境故事法的... -
从HelloWorld和文档注释开始入门Java编程
2020-09-03 06:11:53主要介绍了从HelloWorld和文档注释开始入门Java编程,涉及到Javadoc工具的使用,需要的朋友可以参考下 -
java文档注释规范(一)
2018-09-23 18:13:55Javadoc工具将从四种不同类型的“源”文件生成...每个包都有自己的文档注释。有两种方式来创建包注释文件: package-info.java - 可以包含包的声明,包注解(anotation),包注释和Javadoc 标签(tag)。包注释放在... -
Java-文档注释
2018-08-21 00:15:02(3)文档注释:/*.. 注释内容…./ (这种注释可以用来自动地生成文档。在JDK中有个javadoc的工具,可以由源文件生成一个HTML文档。使用这种方式注释源文件的内容,显得很专业,并且可以随着源文件的保存而保存... -
如何写Java文档注释(Java Doc Comments)
2020-04-19 11:48:48感谢原文作者:李舜阳 ... 本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的...“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释,它是一种... -
将Swift文档注释解析为结构化实体-Swift开发
2021-05-27 06:31:26SwiftMarkup SwiftMarkup将Swift Markup从文档注释解析为结构化文档实体。 import SwiftMarkup let markdown =#“”“创建具有提供的零件和规格的新自行车。-重新SwiftMarkup SwiftMarkup将文档注释中的Swift ... -
idea添加文档注释的快捷键
2021-01-11 15:38:43idea如何快速添加文档注释 解决方法: 在方法上输入/*m后按下Tab键即可,但是这个m是你创建文档注释模板时的Abbreviation中的值,创建文档注释模板请参考:http://www.yayihouse.com/yayishuwu/chapter/2881 ... -
c#中xml文档注释编译dll引用到其它项目示例
2020-09-04 16:21:31主要介绍了c#中xml文档注释编译dll引用到其它项目示例,需要的朋友可以参考下 -
IDEA文档注释设置
2019-08-17 11:56:55设计类的注释 打开 File > Settings > Editor > File and Code Templates,点击class 在类的头部添加如下代码 /** *@ClassName ${NAME} *@Description TODO *@Author ${USER} *@Date ${DATE} ${TIME} *@...