VLC代码分析（一）代码风格

最新推荐文章于 2017-09-07 23:54:57 发布

原创最新推荐文章于 2017-09-07 23:54:57 发布 · 969 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#代码分析 #initialization #comments #interface #跨平台 #string

本文探讨了代码风格的重要性，特别是代码的可读性，并详细介绍了VLC项目的代码风格指南，包括注释格式、语句编排及命名约定等方面。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

代码风格，我认为主要是代码的可读性。可读性意味着：代码格式优美统一；变量，函数，宏，文件的命名清晰明了。很多人的代码，我都看过，给人的第一感觉就是，格式比较杂乱，命名含糊不清，不重视代码的可读性。而软件工程中强调，代码是让机器读的，更重要的是给人读的。试想，一份代码如果只有作者能懂，一旦离职或者抽不出时间维护，那么其他人如果接手？

VLC的代码风格如下：

1 注释格式

注释格式1

/*
 * This is VLC comments 
 * coding style
 */

注释格式2

/* Quadword (64-bit) value */ 前后空一格，首字母大写
注释格式3
    代码风格，我认为主要是代码的可读性。可读性意味着：代码格式优美统一；变量，函数，宏，文件的命名清晰明
了。好的代码，不仅容易理解，毫不夸张的说，可以给人以美的享受。很多人的代码，我都看过，给人的第一感觉就是，格式比较杂乱，命名含糊不清，不重视代码的可读性。软件工
程中强调，代码是让机器读的，更重要的是给人读的。试想，一份代码如果只有作者能懂，一旦离职或者抽不出时间
维护，那么其他人如果接手？

    VLC的代码格式非常统一，举例如下：

1 注释格式

注释格式1
/*
 * This is VLC comments 
 * coding style
 */

注释格式2
/* Quadword (64-bit) value */ 前后空一格，首字母大写，非常美观

注释格式3
/*****************************************************************************
 *
 *****************************************************************************/

函数说明注释

/**
 *
 * /brief 函数简介
 * /param 参数说明
 * /return 返回值说明
 */
 
 
2 语句编排
缩进为4个空格，tab键被4个空格替换，保证所有的编辑器下都能对齐。
括号前后要空格
if( params ) 
{
    ...
} 
else
{
    ...
}

for( int i = 0; i < CON; i++ )
{
    ...
}

do
{
    ...
}
while ( ... );
函数调用格式如下：
msg_Err( p_this, "interface /"%s/" initialization failed",
         newval.psz_string );

VLC的命名风格

由于VLC跨平台，所以命名规则绝大部分遵守了linux的规范

变量前缀，例如
b_ bool
i_ int
p_ 指针
pf_ 函数指针
pp_ 指针的指针
psz_ 字符串指针
看到前缀，自然就明白该变量的类型

VLC的代码风格就简略分析到这里。毕竟这个不是重点。在平时的工作中，我的代码风格和VLC大同小异。其实，只要能形成自己的一套风格，在开发中做到一致，就能给人一种整洁

美观的感觉。