精华内容
下载资源
问答
  • 1、下载阿里eclipse-codestyle.xml:https://github.com/alibaba/p3c/tree/master/p3c-formatter 2、IDEA配置,导入xml:https://www.jetbrains.com/help/idea/2016.2/configuring-code-style.html
    展开全文
  • eclipse规范模板code style

    热门讨论 2011-06-15 17:00:41
    提升java代码的可读行,规范行。该模板严格按照代码的缩进原则进行编写。 使用方法:1 在eclipse中选中一个工程,右键单击->propertys->java code style->formatter->import->导入该xml文件
  • QT 代码规范Artistic Style

    千次阅读 2019-08-19 19:46:34
    https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/contents/ 经过精心整理,确实代码舒服了不少,不过感觉修改太麻烦了。接着前辈让我用一个插件http://astyle.sour...

    新公司适应了两天老板就让该需求,让后我这完全随意的代码规范被狠狠的嫌弃了。
    前辈发给我一份goole的风格规范
    https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/contents/
    在这里插入图片描述

    经过精心整理,确实代码舒服了不少,不过感觉修改太麻烦了。接着前辈让我用一个插件http://astyle.sourceforge.net/ Artistic Style 3.1
    我发现这玩意配合qt简直爽歪歪吖,保存自动规范代码,什么空格、大括号、小括号、星号等等自动整齐。以下是安装方法
    帮助,关于插件,确认自己c++下 beautifier打开
    在这里插入图片描述

    在这里插入图片描述

    在这里插入图片描述

    在这里插入图片描述

    展开全文
  • android代码规范和studio配置CodeStyle

    千次阅读 2017-01-16 11:23:15
    android代码规范和配置codestyle

    studio配置CodeStyle可以很好的帮助我们检测代码规范性,保持大家的代码统一,来看看怎么配置和使用吧


    代码规范,自己公司的一套

    代码规范

    一、      简介

    A.    目的

    本文提供一整套编写高效可靠的 Java代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强。而且,通过遵循这些程序设计标准,你作为一个 Java软件开发者的生产效率会有显著提高。经验证明,若从一开始就花时间编写高质量的代码,则在软件开发阶段,对代码的修改要容易很多。最后,遵循一套通用的程序设计标准将带来更大的一致性,使软件开发团队的效率明显提高。

          

    Note: 规范编码的目的是让开发者更容易理解其他人的代码,而不是约束你编码的方式

    B.    范围

    本指南仅适用于使用Java编写的Android程序代码。

    C.    参考资料

    http://www.oracle.com/technetwork/java/codeconvtoc-136057.html

    http://source.android.com/source/code-style.html

     


    二、      快速入门

    l  驼峰式命名(大小写交替)

    错误:

    public classmyClass

    publicinterface foo

    public finalstatic int max = 100

    public intFooValue

    正确:

    public classMyClass

    publicinterface IFoo

    public finalstatic int MAX = 100

    public intfooValue

    l  使用Javadoc识别的注释

    在函数声明前添加注释(输入”/**”+回车)

    l  精简函数体(最好不要超过40行)

    l  局部变量随用随声明(尽量缩小变量的作用域)

    l  每行最长100字符

    l  缩进用4个空格代替TAB

    l  成员变量名用m开头,static变量名用s开头

    l  前大括号“{”不要单占一行

    错误:

    if(condition)

    {

    //dosomething

        }

    正确:

    if(condition) {

        //do something

    }

    l  多利用标准注解

    错误:

    publicvoidonCreate(Bundle savedInstanceState) {

    正确:

    @Override

    publicvoidonCreate(Bundle savedInstanceState) {

    l  少用不常见缩写

    错误:opnDlg

    正确:openDialog

    三、      命名

    A.  Java命名规范

    命名应符合驼峰式规则,利用大小写字母交替来区分名称中的不同单词,即应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。

     

    1.        尽量使用完整的英文描述符,采用适用于该领域的术语

    2.        采用大小写混合使名字可读

    3.        尽量少用缩写,但如果用了,要明智地使用。

    4.        避免使用类似的名字,或者仅仅是大小写不同的名字

     

    类型

    规则

    示例

    包名

    全部小写字母,URL倒序

    package com.domain.project

    类名

    首字母大写,使用描述性强的名词,避免使用缩写,除非该缩写十分通用(UrlHtml)

    class Raster;

    class ImageSprite;

    接口

    同上。通常以字母I开头。回调接口等特殊情况可不加I

    interface IRasterDelegate;

    interface IStoring;

    interface OnClickListener;

    方法

    使用动词,驼峰式命名,首字母小写

    run();

    runFast();

    getBackground();

    变量

    使用有意义的简短的单词,驼峰式,首字母小写。

    成员变量m开头,JavaBean例外。

    static变量s开头。

    int i;

    float myWidth;

    int mPrivate;

    static MyClass sSingleton;

    常量

    全部大写,用下划线分割单词,static final修饰

    static final int MIN_WIDTH = 4;

     


     

    B.  Android命名规范

    类型

    规则

    示例

    Activity

    XxxxActivity

    MainActivity

    View

    XxxViewXxxLayout

    RedTextViewBluetoothDialog

    Service

    XxxService

     

    BroadcastReceiver

    XxxxReceiver

     

    工具方法类

    UtilsManager为后缀

    ThreadPoolManagerLogUtils

    基础类                    

    BaseXxx

    BaseActivityBaseFragmentBaseDao

    布局xml

    全部小写,以下划线分割,使用名词命名。ActivityFragment的布局文件必须与其类名对应,对应规则为:将所有字母都转为小写,将类型和功能调换。

    activity_main.xml

    fragment_homework.xml

    dialog_bluetooth.xml //对话框

    item_message.xml //列表Item

    vw_titlebar.xml //其他布局文件

    布局id

    全部小写,以下划线分割,view缩写_view的逻辑名称

    layout_citytv_namebtn_submitimg_headlist_message

    图片文件

    全部小写,以下划线分割。

    xxxx_checked.png

    xxxx_focused.png

    xxxx_selected.png

    xxxx_pressed.png

    xxxx_disabled.png

    xxxx_normal.png

    Drawable xml

    selector_xxxshape_xxx

     


    四、     注释

    1.        每个类必须有文件头注释。简要说明类的作用,注明作者和创建时间。标准模板:

    /**

     * Filedescription.

     *

     * @author ${USER}

     * @date ${DATE}

     */

     

    2.        大部分方法都需要方法注释,一些不言自明的方法除外。简要说明方法作用,并解释参数、返回值、抛出异常。方法注释请使用JavaDoc标准。例如:

    /**

    * Description.

    *

    * @param arg1 description

    * @param arg2 description

    * @return description

    * @throws Exception description

    */

    public int getFoo(int arg1, booleanarg2) throws Exception {

       return 0;

    }

     

    3.        关键逻辑或者较复杂的逻辑处,应该添加必要的注释。单行注释使用”//”,多行注释使用/**/

     

    4.        注释必须在程序改变时实时更新。

    5.        简单明了,确保任何程序员都可以读懂。

     


     

    五、      其他规范

    1.        所有文件编码格式为UTF-8

    2.        变量的作用域应该尽量小,需要时才声明,并尽快进行初始化。

    3.        前大括号不要单独占用一行,不要省略单行代码块的大括号。

    正确:

    if (condition) {

        statements;

    }

    错误:

    if (condition)  //没有大括号

    statement;

    错误:

    if (condition)  //前大括号单独占用一行

    {

    statement;

    }

     

    4.        尽量少使用缩写,除非该缩写很常见(HtmlUrl

    5.        缩进使用4个空格替代Tab

    6.        编写代码后必须格式化。AndroidStudio默认格式化快捷键:Ctrl+Alt+L

    7.        在代码中逻辑性代码块的起始、结尾处,都应该加入空行,并在起始处写注释。

    相对独立的程序块之间必须加空行。

    8.        一行代码不超过100字符。超过100字符,请换行或者提取变量。

    9.        方法体不超过40。若超过,则应考虑拆分成多个方法。

    10.    尽量避免使用枚举类,使用常量代替。

    11.    只要是合法的,就把@Override注解给用上。

    12.    规范TODO使用,加上日期和描述,并及时解决删除。AndroidStudio中可以敲todo来使用标准模板。例如:

    // TODO: 2017/1/5简单描述

    13.    采用统一的LogUtils来输出Log。输出的Log要简明扼要。充足的log可以便于定位错误,但Log太多会影响程序性能(I/O耗时)。正式版本应该关闭Log开关。

    14.    Java文件中不允许有多余的import,不允许importjava.io. *

    15.    Warning要解决。

    16.    不允许硬编码,状态值必须定义常量,并添加注释。



    配置CodeStyle

    Android Studio统一配置

     

    1.   配置CodeStyle

    按照上图标注顺序,导入AndroidCodeStyle.xml文件。

    2.   工程文件编码统一为UTF-8


     

    3.   注释模板

     

    注意:请将${USER}修改为自己的名称,模板前后不要有多余的空格与换行符。

    /**

     * File description.

     *

     * @author ${USER}

     * @date ${DATE}

     */


     

    4.   安装使用CheckStyle插件


     

    安装完成后,重启AndroidStudio。然后添加CheckStyle脚本:

     




     

    配置实时检查

     

    使用方法简介:

    -        配置好实时检查后,在编辑器中,不符合风格的代码会直接出现警告:

     

     

    -        Java文件中右键,点击如图选项,即可查看当前文件所有不符合风格的代码段:

     


     

    展开全文
  • Code Style工具规范编码风格

    千次阅读 2017-04-25 17:20:43
    介绍Code Style小工具。

          今天在Spark 的源码目录下建立一个测试文件,只是写了如下Scala 代码:

    package org.apache.spark
    
    import org.apache.spark.internal.Logging
    import org.apache.spark.rdd.RDD
    
    object Test extends Logging {
      def main(args: Array[String]): Unit = {
        logInfo("haha" + classOf[RDD[_]])
      }
    }

          显然,代码并没有什么问题,但是会出现编译错,让把 scalastyle_config.xml 文件放入.idea目录下,放进去后仍报错。于是查了一下该文件:是个简单易用的code style检测工具,非常轻巧。有助于团队风格一致。集成在maven里用很方便。具体参考:scalastyle工具

          原来是scalastyle_config.xml文件中指定

      <check level="error" class="org.scalastyle.file.HeaderMatchesChecker" enabled="true">
    
    
    

          开启了文件开头Lisence检测。而我写的测试代码之前没加Lisence注释。对此又查了一下Code Style相关,这才发现代码风格可以通过代码风格工具控制,是个不错的idea。         

          之前写代码,风格都靠自己控制,大家在svn上提交的代码风格各异,很不利于协作编程,代码也比较混乱。但是有了Code Style小工具,可以产生一定的约束作用。功能重要,代码风格以及后期的可维护性也很重要。网上找了一些Code Style相关文章,如拯救Java Code Style强迫症 周宇刚 给出了一些更为广泛的论述,除了在开发者本地进行风格控制,还可以在提交代码时把好代码风格的关。使用CheckStyle检查编码规范 一文给出了主流IDE(IDEA和Eclipse)下安装CheckStyle插件的方法。


          总之,便于开发者工作的小工具也是不容忽视的。

    展开全文
  • Java 代码规范 (code style + check style)

    千次阅读 2019-11-14 14:12:10
    为什么:统一代码规范的必要性 怎么做: 明确规范 使用规范 1. 为什么:统一代码规范的必要性 为什么需要统一代码规范: 背景:不同的小组\同学,采用不同的代码格式规范,导致每次 format 代码,都有大量的...
  • Google Style中有关C语言的风格规范

    千次阅读 2018-10-17 23:38:14
    Google Style中有关C语言的风格规范 Google 经常会发布一些开源项目,意味着会接受来自其他代码贡献者的代码。但是如果代码贡献者的编程风格与 Google 的不一致,会给代码阅读者和其他代码提交者造成不小的困扰。...
  • 最近在阅读别人给我的一个项目的代码,发现格式比较乱,导致阅读代码效率很低,特意学习了Linux内核代码规范Coding Style,将其整理在这里。
  • Python编程代码规范(Google Style

    千次阅读 2018-07-23 10:01:56
    This is a groups style docs. Parameters: param1 - this is the first param param2 - this is a second param Returns: This is a description of what is returned Raises: KeyError - raises an ...
  • 一张图总结Google C++编程规范(Google C++ Style Guide)

    万次阅读 多人点赞 2014-07-13 21:31:54
    Google C++ Style Guide是一份不错的C++编码指南,我制作了一张比较全面的说明图,可以在短时间内快速掌握规范的重点内容。不过规范毕竟是人定的,记得活学活用。看图前别忘了阅读下面两条重要建议: 1 保持一致也...
  • Google Java Style:Google的Java编程规范

    千次阅读 2015-12-28 09:30:12
    文章转载自:http://mp.weixin.qq.com/s?__biz=MjM5NzMyMjAwMA==&mid=402018579&idx=2&sn=6f96aa32d86d463c7d3047401b38fa25&scene=0#wechat_redirect ...Google Java Style文档是Google Java编程规范的完整定义。 依照
  • 聊聊代码规范(Code Style)

    千次阅读 2015-10-10 13:48:11
    良好的代码规范对项目的开发、维护、扩展都能起到至关重要的作用。 这边代码规范涉及到类、变量、常理、包名、资源等 命名法介绍: 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母...
  • Google JS 规范 背景: JavaScript作为一门弱类型脚本语言,其代码规范一直饱受质疑。它不像java有严格的语法规范。大家都有一套自己的JS代码规范,所以JS代码的...本文是翻译的google的coding style 链接:http://goog
  • 【C/C++】Google 出品的代码规范(Google C++ Style Guide)

    千次阅读 多人点赞 2018-08-13 20:01:22
    翻译整理自 Google C++ Style Guide Ref ...Google C++ Style Guide : 官方原版 C++ Coding Style : 不错的表格...一张图总结Google C++编程规范(Google C++ Style Guide): 非常帮的一张图,可以用于概览,回忆...
  • 编码规范(coding style)是与语言有关的,适合本部门情况的,详细代码书写格式说明,包括代码范例。 编码规范,听起来是个鸡毛蒜皮的小事,实际上,它向所有写代码的团队成员表明了团队对于代码质量和代码...
  • 我们写出来的代码会给很多人看,为了使代码清晰简洁,方便阅读理解,都会统一... 1.Google Objective-C Style Guide  2.Coding Guidelines for Cocoa  简单总结一下目前接触到的:  1.代码行度最大为100列(C++
  • IOS的学习笔记之Objective-C style guide. 转至元数据结尾 创建:张坤楠,最新修改于:二月 26, 2016 转至元数据起始 前言 http://10.9.10.115/svn/client/component/ios/ 学习计划:了解...
  • * Linux kernel coding style * Linux 内核Coding Style整理侵删致歉。1. 缩进 缩进采用8个字符宽度的tab switch和case对齐 switch (suffix) { case 'G': case 'g': mem ; break; case 'M': case 'm': mem <<
  • Java编码规范(The Elements of Java Style)Genaral Principles一般约定 1.Adhere to the style of the original. 保持最初的样式。 2.Adhere to the Principle of Least Astonishment. 遵守最小惊奇原则。 3....
  •  注意:有些低版本的浏览器不能识别style标记,这意味着低版本的浏览器会忽略style标记里的内容,并把style标记里的内容以文本直接显示到页面上。为了避免这样的情况发生,我们用加HTML注释的方式(<!-- 注释 -->)...
  • Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 119,989
精华内容 47,995
关键字:

style规范