转载自:http://luchenqun.com/?p=761 做一个C++方面的符合Doxygen的注释文档,备用. 1.头文件根原文件注释.这个我也不知道需要注释什么.能想到的是:谁写的,里面有些什么内容,文件是什么,版本号,日期等等.所以直接拷贝了网上的一个版本.大家根据情况直接增加或者减少吧.   1 2 3 4 5 6 7 8 9 10 11 12 13 14 /** * Copyright (C), 2015.XXXX公司,All rights reserved. * @file *…

使用unzip的时候 指定 -d选项, 是说明解压到的 目标地址. 这个参数还是比较方便的, 比直接unzip到当前目录, 然后在去拷贝到目标目录, 然后再删除当前目录中的解压文件夹, 方便多了. 使用:x命令, 方便直接; 因为它就类似于(注意不是等于same):wq, 而且, "只有当发生改变时才写入": "only when changes have been made". like和same as. like是类似, 而same是等同于, 所以这里的:x是用…

作为一个强迫症患者,每次想在xml文件用快捷键注释的时候,它自动生成的注释一直都是这样的:这令我非常难受,于是每次我都要把光标移到前面,然后再Tab以下,让它变成这样可是每次都这样,好麻烦啊,如果自己手敲更麻烦了,于是愚蠢的我终于想到可以改掉IDEA默认的注释风格啊!于是开始了摸索之路,摸了半天终于成功了QWQ当我按下快捷键,它生成的注释是这样的了方法:File -> Settings -> Editor -> Code Style -> XML -> Code Gernat…

作者:zyl910 v1.1版的改动如下—— 将源码上传到github. 调整目录结构. 添加CMake编译配置文件. 使用doxygen规范注释. 文件清单—— docs\ docs\images\ docs\images\examples_tcharall.png examples\ examples\tcharall\ examples\tcharall\makefile examples\tcharall\tcharall.c examples\tcharall\tcharall_200…

新版本—— http://www.cnblogs.com/zyl910/p/zlstdint_v100.html[C] zlstdint(让VC.TC等编译器自动兼容C99的整数类型)V1.0.支持Turbo C++ 3等DOS下的编译器 作者:zyl910 一.改动简介 V1.02版的改动如下—— 将源码上传到github. 调整目录结构. 添加CMake编译配置文件. 使用doxygen规范注释. 修正 __AUTO_STDINT_H_USESYS 误为 _INTTYPES_H_SYS_ 的…

良好编程习惯的养成对于一个程序员的发展非常重要,而注释对于一份程序来讲又是一个必不可少的组成部分,今天来研究一下C语言程序的注释风格. 注释是源码程序中非常重要的一部分,一般情况下,源程序有效注释量必须在15%以上. 注释的原则是有助于对程序的阅读理解,所以注释语言必须准确.易懂.简洁,注释不宜太多也不能太少,注释的内容要清楚.明了.含义准确,防止注释二义性,该加的地方一定要加,但不必要的地方一定不要加. 一.模块描述 模块描述中应该包括,版本号.生成日期.作者.内容.功能.与其它文件的关系.修…

1. 如何自动添加注释 可通过如下三种方法自动添加注释: (1)输入“/**”并回车. (2)用快捷键 Alt+Shift+J(先选中某个方法.类名或变量名). (3)在右键菜单中选择“Source > Generate ElementComment”. 2. 如何自定义注释风格 自带的注释格式你不一定喜欢或不符合你公司的标准,那么可以通过下面方法进行修改. (1)Window->Preference 打开参数设置面板,然后选择:Java -> Code Style -> Code…

注释风格 一.前言 注释是源码程序中非常重要的一部分,一般情况下,源程序有效注释量必须在20%以上. 注释的原则是有助于对程序的阅读理解,所以注释语言必须准确.易懂.简洁,注释不宜太多也不能太少,注释的内容要清楚.明了.含义准确,防止注释二义性,该加的地方一定要加,但不必要的地方一定不要加. 注释风格很多,这里只是对于我的代码进行规范. 二.风格 1.文件注释 FileName 文件名 Description 模块描述 Change Logs 变更日志 /* * Copyright (C), 1…

前言 ​ 程序中注释的规范和统一性的重要性不言而喻,本文就推荐一种在用vscode编写代码时自动化生成标准化注释格式的方法,关于Doxygen规范及其使用可查看博文 代码注释规范之Doxygen. ​ 本方法仅作为Doxygen注释的辅助作用. Vs code自动生成Doxygen格式注释 环境 Vs code Generate Doxygen Comments 插件 Generate Doxygen Comments 插件使用及配置 安装插件后,File--Preferences--Setti…

本文转载自https://blog.igevin.info/posts/restful-architecture-in-general/ 在移动互联网的大潮下,随着docker等技术的兴起,『微服务』的概念也越来越被大家接受并应用于实践,日益增多的web service逐渐统一于RESTful 架构风格,如果开发者对RESTful 架构风格不甚了解,则开发出的所谓RESTful API总会貌合神离,不够规范. 本文是我对RESTful 架构风格的一些理解,和大家分享一下,如果有问题,欢迎讨论.…