Board logo

标题: 有没有必要提供这样的代码风格 [打印本页]

作者: zinking    时间: 2005-9-24 20:57     标题: 有没有必要提供这样的代码风格

#ifndef HELP_H #define HELP_H

#include "stdlib.h" #include "stdio.h" #include "string.h" #include "alloc.h"

/************gloab variant**********/

/************define function********/ int help_pos(int posk[],int SPAC,int hp_pos[]); int help_inti(int hp_pos[],int &hp_r,unsigned char *input[],unsigned char ***hp_show);

/************************************************* FUNCTION NAME : help_pos(),计算显示区域和行列数 FUNCTION DESCRIPTION : 根据输入显示区域,计算显示初始坐标,和行列数 INPUT PARAMETER : 显示区域块posk[4](矩形左、右顶点行、列),显示区域与边框空隙SPAC OUTPUT PARAMETER : hp_pos[]起点(行、列),行列数 RETURN VALUE : 0-成功,1-不成功 ERROR REPORT : **************************************************/ int help_pos(int posk[],int SPAC,int hp_pos[]) { hp_pos[0]=posk[0]+SPAC; //x point start hp_pos[1]=posk[1]+SPAC; //y point start hp_pos[2]=(posk[3]-SPAC-hp_pos[1])/16; //row num hp_pos[3]=(posk[2]-SPAC-hp_pos[0])/16; //col num if(hp_pos[2]<1 ||hp_pos[3]<1) return(0); else return(1); }

/************************************************* FUNCTION NAME : help_inti(),计算显示数组 FUNCTION DESCRIPTION : 根据输入显示区域,计算显示初始坐标,和行列数 INPUT PARAMETER : 输入内容数组*input[],起点(行、列),行列数pos[4] OUTPUT PARAMETER : 显示数组*show RETURN VALUE : 0-成功,1-不成功 ERROR REPORT : **************************************************/

int help_inti(int hp_pos[],int &hp_r,unsigned char *input[],unsigned char ***hp_show) { int R; int in_r,in_c;//输入数组下标 int show_r,show_c;//输出数组下标 int hx,hy,hc,hr; int i,j; int ALLOC; //分配地址标志 hx=hp_pos[0]; //显示时行起点 hy=hp_pos[1]; //显示列起点 hr=hp_pos[2]; //显示时行数 hc=2*hp_pos[3];//显示时列数(英文字符数,汉字占2位) /*****分配显示数组地址******/ if(*hp_show!=NULL) free(*hp_show); *hp_show=(unsigned char **)malloc(sizeof(unsigned char *)); if(*hp_show==NULL) {return(1);} ALLOC=1; /*****change in arrar char*******/ ..................................................... ............................................................. ................................................................ 有没有必要提倡这样的代码风格呢? 不知怎么的我就觉得看到这样的代码很“感动”!!


作者: kai    时间: 2005-9-24 23:15

是个很好的方式,类似于Java中的JDoc
对于做项目,是要这样来写。 但是学习中自己的小程序,没有这个必要。
顶多在函数前加个简短的Commant。
看看MSDN,就知道了。
我觉得那个 function name 没有必要再提一遍。
而 function description, input parameter, output parameter,  error handler 很有必要。

你这个投票,我也不知道选哪项了?有必要,绝对来讲,有点过
没有必要,也太武断。 不知道,我也觉得不对。
我只是知道,视情况而定。
作者: zinking    时间: 2005-9-25 12:08

kai 还是有道理啊 ,只是我真的很喜欢看这样写的程序,清楚 一目了然,所以想看看大家对这种风格的喜好情况。
我觉得,好的习惯是慢慢养成的,所以我认为写简单的程序 ,加上comment是必不可少的 。当然支持这种风格的话就更好了
作者: flyship163    时间: 2005-9-30 20:32

   我觉得就是小程序在有时间的时候也还是能加上去比较好,除非小得太可怜了,你说除了做项目的也有一些程序不会太小,如果自己看的话那当然没什么,可是有的时候会让其它人也看啊,那样的话就很有必要了,一看起来感觉就不一样。




欢迎光临 编程论坛 (https://bbs.bccn.net/) Powered by Discuz! 6.1.0