Hola,
Si revisas el manual de highlight_string() (
www.php.net/highlight_string), lo que hace esa funcion es mostrar la cadena, no devolverla. Por decirlo de alguna forma, es como un echo, envia al navegador la cadena coloreada.
A partir de la version 4.2, tiene un segundo parametro, que si le pasas el valor true, devuelve la cadena, que es lo que tu quieres:
Código PHP:
$comment = ereg_replace('[code](.*)[/code]',"<table width=95% cellspacing=0 cellpadding=0 border=0 bgcolor=e2e2e2 align=center><tr><td>".highlight_string("<? echo date("d/m/Y\"); ?>",true)."</td></tr></table>",$comment);
Saludos.