精华内容
下载资源
问答
  • 文字清晰可拷贝,最新注释版本
  • java文档注释要求

    2019-02-21 10:16:34
    一个好的程序员工资的体现不仅仅在于技术的强弱,还体现在注释的书写上
  • 昨天工作需要,看了一批很久以前的代码,对于其中注释:  类似某人某日解决了某个问题的注释,没有一点用处... 所以,各位对于注释要求,要合理、有用。切勿把注释当作法宝,以为有了注释(文档)就万事大吉。 ...

      昨天工作需要,看了一批很久以前的代码,对于其中注释:

      类似某人某日解决了某个问题的注释,没有一点用处,反而添乱。

      对于技术说明类型的,其实也只是个启发,真实意思,还要自己再仔细分析。如果看看注释就明白了,那还要高手干什么?

     

      所以,各位对于注释的要求,要合理、有用。切勿把注释当作法宝,以为有了注释(文档)就万事大吉。

    展开全文
  • 关于注释

    2016-09-23 11:26:03
    数据库命名格式,注释格式等我都写了相应的规则文档,要求程序员按照文档规则加注释。 我在过的几家公司普遍对程序注释不重视。 之前一家游戏公司,做类似cok手游的。他们的服务端用go开发。程序里几乎没有注释,...

    16年6月前我在一家互联网公司做技术经理。数据库命名格式,注释格式等我都写了相应的规则文档,要求程序员按照文档规则加注释。数据库里有哪些字段,程序里有哪些功能,大家可以很方便的获取到。

    后来决定转行做游戏,6月辞职后去了一家游戏公司,做类似cok手游的。他们的服务端用go开发。程序里几乎没有注释,数据库字段也没有注释。公司新人要花费很大的精力去看源代码,很多时间都浪费了。如果有不明白的也不知道该去问谁,而且每来一个新人,老员工都会被同样的问题问一遍,对新人老人都是浪费时间,很没有效率,有时候写代码的人也不记得什么意思。比如有一个属性名叫hasJoinedAlliance,按照他们推崇的程序“自解释”理念,我把这个理解为“已经加入了联盟”,然后就掉坑里了。这个属性真实的意思是“以前加入过联盟,但现在可能不在联盟里”。 再比如,线上游戏每个一两周会有地图错误,就是玩家的城堡在地图上消失了。他们一直查不出来原因,在业务逻辑上看不出任何问题,有可能和服务端底层框架有关。但那个框架是几年前写的,即使那个框架的作者也要费尽去看那些没有注释的代码,害人害己啊。最后我写了个数据修改的脚本,每次出了问题就运行一下。类似的问题还有好多。他们的服务器架构是面向过程的,经常是一个函数几百行,里面各种if和switch。我当时开发的锦标赛和七日目标,要到处插代码。比如训练士兵的函数里,有经验的代码,有战斗力的代码,当然还有有锦标赛和七日目标的,等等。他们说不要为了使用对象而使用对象。好吧,我无语了,这是程序设计的方式,而不是用不用对象的问题。go语言的强大的接口实现分离的理念,他们还应该好好理解一下。

    现在我在另一家游戏公司,兼做unity和java服务端开发。这家公司比上一家还不重视注释,程序里一个注释也没有。我习惯边写代码边加注释,写的注释也比较详细。然而公司要求不能用中文注释,我只好全删掉了。理由是可能会有乱码。程序里一行注释也没有可能就是因为要用英语,所以大家干脆都不写了。我很纳闷啊!unicode自上世界90年代初就有了,哪个IDE不支持utf8?还有就是公司的软件架构,我也不太喜欢。虽然用的是java和c#,服务器架构和unity架构充斥了很多面向过程的东西,代码里大量使用单例和C#委托,有种写c代码的感觉,定义struct加函数指针。每开发一个功能,就要建一个单例,然后所有逻辑都写进去。对于简单的小游戏这个方式效率很高,但是稍微功能多点的游戏,代码就会显得乱。

    最后,我认为程序的注释是必须有的。如果你的英语很牛,可以写出来像unity官方文档那样简单明了又言辞精确的英文,那就用英文,否则还是乖乖的用中文吧,没什么丢人的。即使很牛的程序员也不一定会写文档。

    展开全文
  • Java基本数据类型和注释 Java是一种强类型语言,必须为每一个变量声明一种类型。在Java中一共有8种基本数据类型,其中有4种整型,2种浮点型,1种字符类型(用于表示Unicode编码的代码单元),1种用于表示真值的...

    Java基本数据类型和注释

    Java是一种强类型语言,必须为每一个变量声明一种类型。在Java中一共有8种基本数据类型,其中有4种整型,2种浮点型,1种字符类型(用于表示Unicode编码的代码单元),1种用于表示真值的boolean类型。

    强类型语言:要求变量的使用严格符合定义,必须先定义后使用。一个变量如果被指定为某个数据类型,如果没有进行强制类型转换,他就永远是该类型了。

    整型

    整型用于表示没有小数部分的数值,允许是负数。Java提供了四种整型:

    类型 存储需求 取值范围
    int (默认) 4字节 -2 147 483 648~2 147 483 647
    short 2字节 -32 768~32 767
    long 8字节 -9 223 372 036 854 775 808~9 223 372 036 854 775 807
    byte 1 -128~127

    取值范围可以这样理解(以int举例):一个字节表示8位,因此4个字节有32位,一位可以表示2个字符,32位可以表示2322^{32}个数字,正数,负数,0平均,然后正数是负数的绝对值减1即可。

    在通常情况下,int类型最为常用,但是表示某些很大的数比如首富的钱数就要用长整型long。byte, short适合于特定场合,比如底层文件的处理或者存储空间很宝贵的大数组。如果有的数特别大甚至超过long的取值范围,我们也可以用科学计数法表示,但变量要声明为double,如下表示2×10102\times 10^{10}

    double num = 2E+10
    

    长整型数值后缀有一个l 或者L,定义时应该按照如下格式定义:

    long num = 1000L; 		//后边的L不能省略
    

    但是在实际使用时,我们会发现有时候即便不加L或者l,编译时依然会通过,输出也正常,如下:

    long num = 1000;		//对num打印输出的结果是1000;
    

    上边已经指出,不声明时默认整型是int型,这里之所以没有报错是因为存在了自动类型转换,使int自动转换为long型,但是出现以下这种情况使,编译器就会报错:

    这是因为100 000 000 000 000 000已经超出了int类型的取值范围,因此就不会自动进行类型转换,从下图可以看出,当在数值后边加上L表明这是长整型时,编译通过。

    十六进制有一个前缀0X或者0x,如(0xCAFE)表示的就是一个十六进制数。

    八进制有一个前缀0,例如010对应8进制的8,但是这种表示很容易混淆,因此最好不要使用8进制常数。

    从Java 7.0开始,加上前缀0B或者0b,就可以写二进制数,例如0b1001就表示十进制数9。同样这个版本,可以位数字字面加下划线,如用1_000_000(或0B1111_0100_0010_0100_0000)表示100万,这些下划线只是为了让人易读,编译时会自动去除这些下划线。

    浮点类型

    浮点数用于表示有小数部分的数值,在Java种有两种浮点型:

    类型 存储需求 取值范围
    float 4字节 大约±3.40282347E+38F\pm 3.40282347E+38F(有效位数6~7位)
    double(默认) 8字节 大约±1.79769313486231570E+308\pm 1.79769313486231570E+308(有效位数15位)

    double表示这种类型数值的精度时float的两倍,也成为双精度。float类型的数值后有一个F或者f,定义格式如下:

    float num = 2.1f;		//后边的f不可以省略
    

    如果没有f的浮点数值总是默认是double型,与long不同的是,如果缺少f,不论数值是否在float型的范围内,都会报错,因为double类型不能自动向float型转化。

    下面是用于表示溢出和出错情况的三个特殊浮点值:

    正无穷大:一个正数除以0的值,用常数Double.POISITIVE_INFINITY表示。

    负无穷大:一个负数除以0的值,用常数Double.NEGATIVE_INFINITY表示。

    NaN:计算0/0或者负数的平方根的结果,用常数Double.NaN

    注意:Double.表示对于类的调用,后续会指出这种调用方式。所有的“非数值的值”比如NaN,虽然看上去一样,但是都是不同的,可以用Double.isNaN方法判断是否是非数值的值。此外,直接运行0/0之类的运算会抛出ArithmeticException,表示算术异常。

    浮点值不适用于无法接受舍入误差的金融计算。例如:

    System.out.println(2.0-1.1)			//结果:0.8999999999999999
    

    输出结果并非是我们认知的0.9,这种误差主要来源于浮点数值来源于二进制系统表示,而二进制系统无法准确表示分数110\dfrac{1}{10},如果计算要求不允许有任何误差,就应该使用BigDecimal类。

    字符类型

    char类型原本用来表示单个字符,不过现在有的Unicode字符需要两个char值。

    char类型字面量值要用单引号括起来。例如’A’是编码值为65的常量。与’A’不同的是,"A"表示的是一个字符A的值。我们目前可以这样理解,字符代表了一个常量,可以进行数值计算,并且结果可以根据类型可以转换为字符型或者整型,如下:

    int i = 'A'-1;	//对i打印输出的结果是64,输出的为字符型
    
    char i = 'A'-1;	//对i打印输出的结果是@,输出的为整型
    

    char类型的值可以表示十六进制的值,范围从\u0000~\uFFFF,其中\u表示后边跟的数是十六进制数。

    下边给出常见的转义序列:

    转义序列 名称 Unicode值
    \b 退格 \u0008
    \t 制表 \u0009
    \n 换行 \u000a
    \r 回车 \u000d
    \" 双引号 \u0022
    \’ 单引号 \u0027
    \\ 反斜杠 \u005c

    这些转义序列都可以用于加引号的字符或者字符串中,例如"Hello,World\n",\u也可以用在字符串或者字符之外,例如public static void main(String\u005B\u005D args)也是正确的。其中\u005B和\u005D分别是[ 和 ]的编码。

    **需要注意的是,Unicode转义序列会在代码解析前就进行处理。例如System.out,println("\u0022+\u0022")**打印的结果是一个空串,因为\u0022表示一个",那么运行时可以理解""+"",两个空串进行连接,结果还是空串。

    boolean类型

    boolean类型有两个值:false(默认值)和true,用来判定逻辑条件,与C++不同的是,整型值和布尔值不能相互转化,数值不能代替布尔值。

    注释

    在Java语言中有3种标记注释的方式,并且注释不会出现在可执行程序中。因此如果必要可以添加无限多的注释,而不需要担心代码膨胀。

    1. 最常用的注释方法是使用//,其注释内容从//开始到该行末尾;
    2. 当需要更长的注释,既可以在每行的注释前标记//,也可以用/* 和 */这一对注释界定符将需要注释的地方括起来,跨行进行注释。
    3. 这种注释可以用来自动地生成文档,这种注释从/**开始,到*/结束。
    展开全文
  • Java代码注释规范详解

    2020-09-02 19:50:01
    代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用。下面给大家分享java代码注释的规范,需要的朋友参考下
  • 软件技术文档撰写要求文档 文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。 ① 对于面向管理人员和用户的文档,不应像开发文档(面向软件开发人员)那样过多地使用软件 的专业...
  • js函数注释方式

    千次阅读 2018-12-13 20:43:39
    而某些技术不是很好的,但是又想写出逼格很高的代码,无非就是让别人很难阅读,可是,过了一周、一个月,半年,某一天产品经理要求在项目中改动一些功能,或者是软件优化升级,再回头看当初的代码,自己都是一脸懵逼...

    在写代码的过程中(不局限于JavaScript),不管是为了方便以后自己修改,还是方便他人阅读,都需要在代码中增加相应的注释。而某些技术不是很好的,但是又想写出逼格很高的代码,无非就是让别人很难阅读,可是,过了一周、一个月,半年,某一天产品经理要求在项目中改动一些功能,或者是软件优化升级,再回头看当初的代码,自己都是一脸懵逼,“这都写的啥啊,不会是个傻子吧!”,这时候,代码注释就显得尤为重要了,这也是一个前线码农的基本职业素养。不多说,介绍一种既不影响代码阅读(注释如果写在行间的话,会影响代码可读性),又不影响代码理解的注释方法。看代码(仅供新手参考,大神请绕行.....)

     

    /*  
            *   randomNum 利用random函数生成一组随机数(两个) 
            *
            *   版本:(版本:如果有版本需要说明版本的作用以及被注释的版本名称)
            *       1.01
            *   作者:
            *       夫_子
            *   时间:
            *       2018年12月13日
            *   
            *   参数:
            *       minNum  最小值   number  默认值10
            *       maxNum  最大值   number  默认值100
            *       注意:此函数返回一组对象,一次产生两个随机数
            * 
            *   return:
            *       size  返回的是一组随机数对象   object
            * 
            *   1、根据传入的参数设置产生随机数的范围,如果没有传入参数,默认范围为10-100;
            *   2、创建一个对象size,用来存储产生的一组随机数,对象的两个属性分别为x,y,属性值对应产生的两个随机数。
            *   3、返回创建的对象。
            * 
            * 
            * 
            *
            */
    
    
    
            //一组随机数
            function randomNum(minNum,maxNum){
                var minNum=minNum||10;
                var maxNum=maxNum||100;
                var size={};
                size.x = parseInt(Math.random()*(maxNum-minNum)+minNum);
                size.y = parseInt(Math.random()*(maxNum-minNum)+minNum);
                return size;
    
                 /* 1.01
                name
                */
            }
    

     

    展开全文
  • Java1.6.0实现系统托盘技术演示:本演示程序实现了点击按钮窗体关闭,托盘图标挂于系统托盘上,鼠标双击托盘图标,窗体显示,托盘图标消失,在托盘图标上点右键可弹出选择菜单(显示窗口,退出系统,Author),分别...
  • 本文就说一说如果在Eclipse中设置代码注释模版,技术经理可以要求所有的开发人员设置为统一的代码注释模版。 博客正文 1、 打开Eclipse,进入菜单Window->Preferences,打开首选项对话框如图: 2、在左侧树...
  • RSSI测距定位技术性能仿真目录一、仿真要求二、仿真方案的设计、仿真结果及结论1.仿真方案的设计2.仿真结果3.结论三、完整仿真代码 一、仿真要求 要求一:RSSI的测量值由对数路径损耗模型产生,为减小波动造成的误差...
  • GB1400视图库第1部分,pdf格式,清晰完整,带目录哦,带注释,开发视图库必备资料
  • GB1400视图库第3部分,pdf格式,清晰完整,带目录哦,带注释,开发视图库必备资料
  • GB1400视图库第二部分,pdf格式,清晰完整,带目录哦,带注释,开发视图库必备资料
  • 抓取网站后,您可以将注释保存到保存在数据库中的每篇文章中,以便稍后(您猜对了)返回注释! 如果愿意,您甚至可以与自己进行伪造的“笔记战斗”! 但是请不要。 该应用程序是实时运行的,如果您在其他人的应用...
  • 这是一个应用程序,可让您添加注释,对其进行编辑,甚至在运行时进行保存。 这是android Nougat默认Notes应用程序的升级,具有在多屏幕中使用的功能。 设置/安装要求 复制克隆副本中的链接或下载,然后在Android ...
  • 应用程序注释 团体成员 阿曼达 达戈维耶 科格伦纳巴 辛菲亚 对象 欧洲地理信息系统应用指南的注意事项。 Travail需求 各种需求的应用程序中需要更改,更改,更改,更改,更改,更改,更改,更改,更改,更改,更改,...
  • 本应用注释主要介绍可以利用的温度传感器(热电偶、电阻温度检测器(RTD)、热敏电阻器与热敏二极管)以及连接传感器与模数转换器所需的电路,并介绍对模数转换器的性能要求。  热电偶  热电偶由两种不同类型...
  • 由于公司官网不是本人编写的,于是就去看代码,上位仁兄的技术确实没的说,大牛一位,从代码中就可以看出来。只是这位仁兄不喜欢写注释,所以我就悲催了,很多都不知道写的啥子,数据也没有注释。 没有办法只能自己...
  • 珠心算是一种通过在脑中模拟算盘变化来完成快速运算的一种计算技术。珠心算训练,既能够开发智力,又能够为日常生活带来很多便利,因而在很多学校得到普及。 某学校的珠心算老师采用一种快速考察珠心算加法能力的...
  • 中提供了所有技术要求和文档。 接触 有关PharmCAT项目的问题,请联系 责任 :warning: 对于因使用PharmCAT而引起的或与之相关的任何人身伤害或财产损失,PhamCAT不承担任何责任。 用户认识到使用PharmCAT的风险自负...
  • MFC自定义界面HUI,高效简单,含详细注释和示例。 HUI包括基本控件、按钮、标签、编辑框、表格、悬停提示等,可组合出更多功能。资源占用少,效率高,能在低端机上运行,流畅不闪烁,完全满足工控等各种专业软件...
  • 通过一个以学校为背景的校园网建设项目的综合实训,使学生在Red Hat Enterprise Linux 7操作系统平台上,掌握服务器的管理与配置技术,学会搭建一个中小型校园网的设计细节和施工流程,为今后架设综合网络平台以及云计算...
  • 有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学...
  • 2.具体要求 本设计基于灰度积分投影技术的眼睛定位方法,再结合perclos技术。首先通过图像预处理技术得到灰度分配较为均匀的图像,然后分别利用水平和垂直灰度积分投影曲线结合人脸的结构特征找到眼睛的位置坐标,...
  • 由于技术的配合和心理状态等各种因素的影响, 一般P[i][ j]不一定等于Q[i][ j]。男运动员i和女运动员j配对组成混合双打的男女双方竞赛优势为P[i][ j] * Q[i][ j]。设计一个算法,计算男女运动员最佳配对法,使各组...
  • 研究人员有兴趣学习更多有关3D和VR可视化技术的知识,其内容是针对入门级的,无需任何编程经验。 学习成果 在研讨会结束时,参与者将能够: 确定如何将3D可视化和VR潜在地用于从研究数据中得出见解。 认识基本的硬件...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 705
精华内容 282
关键字:

技术要求注释