相关疑难解决方法(0)

说服别人评论他们的代码有什么好的理由？

我注意到许多程序员喜欢编写代码的速度,而没有评论而是为自己和其他人留下一些文档.当我试图说服他们时,我会听到一半被烘焙的东西,比如"方法/班级名称应该说它做什么"等等.你会怎么说他们改变主意？

如果您反对评论,请发表评论.对于试图说服人们评论代码的人来说,这应该是一种资源,而不是其他.:-)

其他相关问题是:评论代码,您是否评论您的代码以及您希望如何评论.

我们都知道,对我们的代码进行评论是编码风格的一个重要部分,可以使我们的代码可以理解为下一个人,或者甚至是我们在6个月左右的时间.

然而,有时评论只是没有削减芥末.我不是在谈论明显的笑话或排泄沮丧,我说的是那些似乎试图解释的评论,但这样做很差,他们可能也不会在那里.评论太短,太神秘,或者只是完全错误.

作为一个故事,你能否分享你所看到的那些真的那么糟糕的东西,如果不是很明显,请展示它所指的代码并指出它有什么问题？什么应该在那里,而不是已经走了吗？

也可以看看:

• 什么时候不评论您的代码
• 你觉得怎么样？(最佳实践)
• 您遇到的源代码中最好的评论是什么？

我想知道人们的代码中是否有标准的评论格式.没有东西像一个方法或类XML注释,而是评论中的方法.

也可以看看:

是否有用于评论C#代码的标准(如phpdoc或python的docstring)？

我想知道,如何以完美的专业风格编写程序.很多时候我们编写了一个非常好的程序/代码来提供准确的输出.一个人可能会使用最好的算法来解决给定的问题.

但对于正在阅读您的代码以供他/她参考的人,由于不正确使用变量/函数名称而变得难以理解代码.(以及许多其他问题)

那么如何以专业的方式实现编写代码的完美性呢？

您可以直接编辑以下代码来详细说明您的想法. (不要编辑问题中的代码:)

您也可以以专业的方式在最后重写完整的代码.将会提供很多帮助.

(C中的简单堆排序算法)

#include<stdio.h>
#include<conio.h>

void insert(int i);
void swap(int *,int *);
void heap_sort(int);

int a[20];

void main()

{

        int n,i;
     clrscr();

     printf("Enter the no of elements : ");
     scanf("%d",&n);
     printf("\nEnter the elements : \n");
     for(i=0;i<n;i++)
     scanf("%d",&a[i]);
     heap_sort(n);
     printf("\nSorted array is : \n");
     for(i=0;i<n;i++)
     printf("\t%d",a[i]);
     getch();
}


void swap(int *p,int *q)
{

     int temp;
     temp=*p;
     *p=*q;
     *q=temp;

}


void heap_sort(int n)
{

     int x=1,i;
     while(x<n)
         {
   for(i=1;i<=n-x;i++)
   insert(i);
   swap(&a[0],&a[n-x]);
   x++;
         }
}



void insert(int i)
{ …