0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

怎么样规范自己的代码

麦辣鸡腿堡 来源:嵌入式Linux系统开发 作者:Jasonangel 2023-10-07 14:51 次阅读

每个人都有自己的编码风格,但如果要和别人协同开发软件,最好是采用一样的风格,可是强行要求他人更改编码风格可能会比较难,那么有没有更好的解决方式呢?

当然有,在软件的世界中,有需求就会有解决方案,毕竟大神那么多。

格式化 C、C++ 代码有一个好用的工具:clang_format。

clang_format 支持多种代码风格:Google, Chromium, LLVM, Mozilla, WebKit,也支持自定义风格(通过编写.clang-format文件),很方便的统一代码格式。

Linux下安装Clang-format :

sudo apt-get install clang-format

具体的使用大家可以百度,很简单,肯定比我讲的全。

另外,推荐使用 VSCode 的 C/C++ 插件,自带了 Clang-Format 格式化工具,不仅拥有上述 5 种排版格式,还定义了自己的 Visual Studio 排版格式,且此格式是默认的排版格式(Ubuntu下格式化快捷键:Ctrl+Shift+I,Windows下格式化快捷键:Shift+Alt+F)。

格式化前:

图片

安装了C/C++ 插件后,鼠标右键,选择格式化文档。

格式化后:

图片

C、C++ 代码可以使用 clang_format 格式化,java 代码呢?不用担心,Android Studio 有内置的格式化代码的工具,不需要自己安装插件和工具。

选中文件,右键,选择Reformat Code,即可将我们的 java 代码格式化成谷歌的代码风格。

图片

通过以上的方式,我们完成了代码风格的格式化,包括大括号小括号位置、换行设置等。那下一步,就是规范我们的命名。

Android 有自己的命名风格,包括局部变量、静态变量、类名、包名、接口、try - catch 闭包规定等,都有很大的不同。

在Linux 中喜欢用下划线分割,在 Android 中需要遵循驼峰原则,具体的Android 中 java 编码命名规定,。

Android 命名规范举例:

非常量字段名以 LowerCamelCase 风格的基础上改造为如下风格:

基本结构为 scopeVariableNameType。

scope:范围
非公有,非静态字段命名以m开头。
静态字段命名以s开头。
公有非静态字段命名以p开头。
公有静态字段(全局变量)命名以g开头。
public static final 字段(常量) 全部大写,并用下划线连起来。
public class MyClass {  
      public static final int SOME_CONSTANT = 42;  
      public int pField;  
      private static MyClass sSingleton;  
      int mPackagePrivate;  
      private int mPrivate;  
      protected int mProtected; 
      public static int gField; 
}

希望我们实现功能的同时,能够拥有一个好的编码风格,这样别人看我们的代码会感觉很舒服,像欣赏一个艺术品。

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • Android
    +关注

    关注

    12

    文章

    3851

    浏览量

    125642
  • Linux
    +关注

    关注

    87

    文章

    10990

    浏览量

    206738
  • 代码
    +关注

    关注

    30

    文章

    4556

    浏览量

    66784
  • 系统
    +关注

    关注

    1

    文章

    981

    浏览量

    21036
收藏 人收藏

    评论

    相关推荐

    【分享】verilog代码书写规范

    FPGA verilog代码书写规范,很好的借鉴
    发表于 05-21 11:36

    FPGA实战演练逻辑篇39:代码风格与书写规范

    规范代码风格,但笔者会尽力结合自己多年的工程实践经验,给出一些具有较高参考价值的知识要点。(特权同学,版权所有)
    发表于 06-19 10:38

    FPGA实战演练逻辑篇40:代码书写规范

    VHDL代码书写规范可供参考,但是相信每一个稍微规范点的做FPGA设计的公司都会为自己的团队制定一套供参考的代码书写
    发表于 06-23 14:01

    Verilog HDL代码书写规范

    1. 目的本规范的目的是提高书写代码的可读性、可修改性、可重用性,优化代码综合和仿真的结果,指导设计工程师使用VerilogHDL规范代码
    发表于 12-08 14:36

    FPGA的代码书写规范

    VHDL代码书写规范可供参考,但是相信每一个稍微规范点的做FPGA设计的公司都会为自己的团队制定一套供参考的代码书写
    发表于 04-16 04:08

    C#编程源代码规范

    C#编程源代码规范 注:目的:为了保证开发队伍中的所有程序员都能够理解其他人编写的代码。 参考: 《华为编码规范和范例》 《凯润软件
    发表于 02-09 16:11 81次下载

    Verilog代码书写规范

    Verilog代码书写规范规范的目的是提高书写代码的可读性、可修改性、可重用性,优化代码综合和仿真的结果,指导设计工程师使用
    发表于 04-15 09:47 106次下载

    verilog代码规范

    verilog代码规范,学会写代码还不行,我们需要更加的规范
    发表于 03-25 14:43 24次下载

    嵌入式代码之编写规范

    嵌入式代码编码规范,用于规范自己代码,增强可读性,非标准规范。最好能强制
    的头像 发表于 04-26 15:21 4926次阅读

    单片机控制调试信息输出的方法

    输出是一种非常有帮助的方式。以往我都是在设计中使用 printf 输出想要看到的关键变量,最后在发布版中在把这些 printf语句删除。之前写的都是小项目,代码可重用性不高,这次我想规范自己
    发表于 12-03 12:06 0次下载
    单片机控制调试信息输出的方法

    科普一下Verilog代码命名规范

    命名规范包括模块命名规范代码命名规范代码命名需要有确定的含义,提高代码可读性和可维护性。
    的头像 发表于 11-17 09:54 2923次阅读

    代码命名规范是真优雅呀!代码如诗

    Java项目的代码结构,能够体现它的设计理念。Java采用长命名的方式来规范类的命名,能够自己表达它的主要意图。配合高级的IDE,可以减少编码人员的记忆负担,靠模糊的匹配就能找到自己
    的头像 发表于 03-13 09:32 546次阅读

    CheckStyle插件导入代码规范

    ,所以大部分公司会给定自己的check规范,一般导入给定的checkstyle.xml文件即可实现。 作为新人,我checkstyle了一整个项目,苦不堪言,所以大家怕是还是多注意代码规范
    的头像 发表于 06-19 09:38 692次阅读
    CheckStyle插件导入<b class='flag-5'>代码</b><b class='flag-5'>规范</b>

    IDEA 神器怎么修改不规范代码

    ,所以大部分公司会给定自己的check规范,一般导入给定的 checkstyle.xml 文件即可实现。 作为新人,我checkstyle了一整个项目,苦不堪言,所以大家怕是还是多注意代码规范
    的头像 发表于 07-08 09:25 547次阅读
    IDEA 神器怎么修改不<b class='flag-5'>规范</b>的<b class='flag-5'>代码</b>

    FPGA的Verilog代码编写规范

      注:以R起头的是对编写Verilog代码的IP设计者所做的强制性规定,以G起头的条款是建议采用的规范。每个设计者遵守本规范可锻炼命名规范性。
    的头像 发表于 08-15 16:23 1223次阅读