Code Comment Web Report 1

[ajikoe]

Hello,

I use Visual Code Comment Web Report, I found that the line spacing between the "member" statement and "description" statement is not the same, this make the description a little bit higher than the member statement.

Is that normal, can we fixed it?

Sincerely Yours,
Pujo

 

[AmazingGrace]

Hi,

I just ran the tool to see if I could see what you were describing. The columns show up on the same line to me... I jumped into the HTML source and it even puts the column headers inside the same <TR> element:

TABLE CLASS="InfoTable" cellpadding=0 cellspacing=0>
<TR height=20>
<TD width=20>&nbsp;</TD>
<TD valign=top align=left width=9 bgcolor="#cccc66"><IMG SRC="../graycorner.jpg" align=top></TD>
<TD CLASS="TableLightLabel" WIDTH=206>Members</TD>
<TD CLASS="TableLightLabel" >Description</TD>
<TD width=20>&nbsp;</TD>
</TR>
...

I'm running IE6.0 btw to view html.

There's no reason why you can't alter the html to suite your needs after its been generated.

 

[ajikoe]

hello,

What i mean about line spacing problem is that the statement inside member column is lower than the statement inside description column.

They are not in the same line somehow.
Forexample:
Members Description
SomeDescriptionForFunction1
FunctionName1

SomeDiscriptionForFunction2
FunctionName2


They should be like this:
Members Description
FunctionName1 SomeDiscriptionForFunction1
FunctionName2 SomeDiscriptionForFunction2

Sincerely Yours,
Pujo

 

[AmazingGrace]

Wow, that really is a strange problem!

(1) Do you always have this result when you use Build Comment Web Pages?

(2) Is this how the HTML looks when viewed inside of Visual Studio's web page viewer?

(3) What version of IE do you have installed, and what other browsers are installed on the computer? How does the formatting appear when viewed in another browser?

 

[ajikoe]

Sorry about the model posted before is not 100% correct

I think I should preview post first before submitting it:

Members Discription
FunctionDiscription1
FunctionName1

FunctionDiscription2
FunctionName2

I hope this time it gives a better understanding.

I always get that model if I use web comment web pages, and I always use the Visual Studio to see it.

my IE is 6. and I have firefox.

I tried to view it using firefox and I found that firefox give a much better result than my IE 6.0

Is the problem in my IE 6?

Sincerely Yours,
Pujo

 

[AmazingGrace]

Hmm, now I can see the same problem in my browser. Apparently the issue is with vertical alignment of text inside the <TD> tags. You might try editing the stylesheet used by VS when generatating the code pages. Search your drive for the file called "CommentReport.css" and try to tweak its style definitions. I'd back it up beforehand, though

 

[ajikoe]

Hello,

I can't see in what place I can tweak the CommentReport.css, and if this is about its style definitions why the firefox browser can show the right page than my IE?

Sincerely Yours,
Pujo Aji

 

[AmazingGrace]

You can add an entry to the CommentReport.css that fixes the problem. Apparently, FireFox does not handle margin spacing the same as IE... If you google search for "firefox css" you will find links on that topic.

After the Comment Pages have been generated, open CommentReport.css and find the style declaration for .TableLightDesc

Inside the braces, add this entry:
VERTICAL-ALIGN: top;

Save the file and refresh your documentation in the IE browser. Everything should be lined up now.

Keep in mind that each time you generate documentation, the CommentReport.css file gets overwritten and takes out the VERTICAL-ALIGN style directive.

 

[ajikoe]

Hello,

Thanks it is working, but can we do more than that, for example is there any way to change the setting inside of Web Comment Report so it always put :
Vertical-Align: top;
instead of removing it...?

Sincerely Yours,
Pujo

 

[AmazingGrace]

I think so. I couldn't find a default template that VS is using but using the Macro Editor to create a macro might do it. I'd make a macro that does the following:
-1- Initiates the documentation procedure
-2- Edits the CommentReport.css to add VERTICAL-ALIGN

I'd post the macro code for you, but I'm not familiar with the IDE object model ATM...

I hope it works for you!